tl;dr: Descripción de tu proyecto, de ser posible mantenlo corto.
Ejemplo: Bienvenido Luisito al repositorio del proyecto X
Este proyecto es una plantilla para crear proyectos en DevSpace. Puedes forkearla y modificarla o simplemente tomar lo que necesites. Modifícala a tu gusto. No es necesario referir a este documento en los créditos. El proyecto cuenta ya con:
- README.md
- Etiquetas estándar en la sección de issues.
- Etiquetas en el about del proyecto.
- Template para HACKLOG.md
- Archivo LICENSE con licencia MIT.
Añade aquí una lista de requerimientos para poder levantar el proyecto en el caso de que sea uno de desarrollo (Recuerda que los repos pueden tener proyectos no exclusivamente de código).
Ejemplo:
- Editor de código
- Node.JS
- Git y Gitkraken
- Un navegador web
-
Escribe aquí el primer paso.
Descripción breve del primer segundo.
npm install -g ejemplo mv .example.env .env
¿Qué sucede con este paso?
Nota: Información adicional de este paso.
-
Segunda instrucción.
Descripción breve del primer segundo.
comando otro comando
¿Qué sucede con este paso?
Utiliza como guía la sección de Descarga
Utiliza como guía la sección de Descarga
Incluye aquí las formas de contribuir a tu proyecto.
Ejemplo:
Revisa por favor si puedes contribuir primero con los issues solicitados en el apartado de issues del Repositorio
Considera contribuir al proyecto de cualquier forma. Un buen inicio es la documentación o agregando tu username de twitter o github en este documento. Las modificaciones son aceptadas por pull request en el siguiente repositorio. Repositorio.
- Incluye una lista de referencias en caso de aplicar en este repositorio
{} con ❤️ por la comunidad de DevSpace.