Este README es una plantilla y conjunto de recomendaciones que ayudan a estructurar un proyecto antes de enviarlo como propuesta al Reto.
Para seguir mejores prácticas de documentación de proyectos código abierto, puedes ver el repo-guidelines de Codeando México.
Recuerda revisar la convocatoria completa del RetoViajesTransparentes.
##Dependencias Esta sección debe tener una lista completa de todas las dependencias necesarias para ejecutar el proyecto.
##Instalación / Configuración Esta sección es una guía paso a paso para instalar el proyecto. Se recomienda una lista ordenada.
##Screenshots Añadir algún screenshot interesante del proyecto. Muy recomendable.
##Demo Un enlace a una demostración en línea de su proyecto, así como un link a un screencast de máximo 4 minutos.
##¿Preguntas o problemas? Esta sección describe cómo otros desarrolladores y los usuarios deben interactuar con su proyecto. Aquí un ejemplo:
Mantenemos la conversación del proyecto en nuestra página de problemas [issues] (https://github.com/CodeandoMexico/repo-guidelines/issues). Si usted tiene cualquier otra pregunta, nos puede contactar por correo retos@codeandomexico.org.
##Contribuye Sección para explicar cómo contribuir a su proyecto. Debe añadir enlace al archivo CONTRIBUTING.md. Ejemplo:
Queremos que este proyecto sea el resultado de un esfuerzo de la comunidad. Usted puede colaborar con código, ideas and bugs.
##Equipo Indique los miembros del equipo principal que son responsables del desarrollo y mantenimiento de este proyecto. Añadir una referencia a sus perfiles de GitHub/Twitter/LinkedIn. Ejemplo:
##Licencia Sección para agregar la licencia. Recuerda agregar el LICENSE.txt al repositorio.