Escribir un párrafo describiendo el proyecto. Intentá explicarle al lector, de qué se trata el proyecto.
#[[## Referencias]]#
Agregar acá links a los tickets de Redmine que correspondan o a la documentación en Drive
- #00000 - Titulo de la tarea
- Título del documento - Breve descripción del doc
- etc
#[[## Getting Started]]#
Instrucciones para obtener una copia funcional del proyecto corriendo en la máquina local para desarrollo y testing del propio proyecto. Ver sección de instalación/deploy para indicaciones de puesta en marcha para uso.
#[[### Prerequisitos]]#
Cosas que se necesitan previo a instalar el proyecto e indicaciones para instalarlas
Dar ejemplos
#[[### Instalación]]#
Una serie de ejemplos paso a paso que explican como tener un entorno de desarrollo levantado
Describís un paso
Das un ejemplo
Repetir
hasta terminar
Terminá con un ejemplo para obtener información del sistema o usarlo para una pequeña demo
#[[## Ejecutando los tests]]#
Explicá como ejecutar los tests automatizados para este sistema
#[[### Detalle de los tests]]#
Explicá lo que prueban estos tests y por qué
Dar ejemplo
#[[### Y estilos de código]]#
Explicá lo que prueban estos tests y por qué
Dar ejemplo
#[[### Otras necesidades específicas del proyecto]]#
Explicá si se utilizan otras herramientas. Explicá como configurar todo.
Dar un ejemplo
#[[## Deployment]]#
Agregá notas adicionales de como hacer un deploy a un sistema productivo
#[[## Magento 2]]#
#[[### Componentes]]#
Explicá como hiciste tu módulo. Usaste Plugins u Observers? Dónde está el punto de entrada del módulo?.
#[[### Extensiones]]#
Explicá como extender tu módulo.
Da un ejemplo
#[[### Configuraciones]]#
Dá una visión general de las configuraciones.
| Section | Group | Field | Description |
|---|---|---|---|
| web | default | cms_home_page | Select the CMS Home Page |
| web | default | cms_no_route | Select the 404 Page |
| web | default | cms_no_cookies | Select the No Cookies Page |
#[[## Versioning]]#
Usamos SemVer para el versionado. Para las versiones disponibles, mirá los tags de este repositorio.
#[[## Autores]]#
- Ricardo Mollo - Initial work - SemExpert
- Indio Solari - Agregó X feature - Indio Solari
También revisa la lista de contribuyentes que participaron de este proyecto.
#[[## Licencia]]#
Escribí la información de la licencia correspondiente. Debería ser propietario para código de repositorios privados y MIT para repositorios públicos.
#[[## Acknowledgments]]#
- Hat tip to anyone who's code was used
- Inspiration
- List other resources, that may be useful to get into this project