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.