Skip to content

Instantly share code, notes, and snippets.

@davixcky
Forked from Villanuevand/README-español.md
Created January 14, 2018 03:26
Show Gist options
  • Save davixcky/535bdc835921cec97ea5d09dc35f7d9e to your computer and use it in GitHub Desktop.
Save davixcky/535bdc835921cec97ea5d09dc35f7d9e to your computer and use it in GitHub Desktop.
Una plantilla para hacer un buen README.md. Inspirado en el gist de @PurpleBooth => https://gist.github.com/PurpleBooth/109311bb0361f32d87a2

Título del Proyecto

Acá va un párrafo que describa lo que es el proyecto

Comenzando

Estas instrucciones te permitirán obtener una copia del proyecto en funcionamiento en tu máquina local para propósitos de desarrollo y pruebas. Mira Despliegue para conocer como desplegar el proyecto.

Pre-requisitos

Que cosas necesitas para instalar el software y como instalarlas.

Da un ejemplo

Instalación

Una serie de ejemplos paso a paso que te dice lo que debes ejecutar para tener un entorno de desarrollo ejecutandose

Dí cómo será ese paso

Da un ejemplo

Y repite

hasta finalizar

Finaliza con un ejemplo de cómo obtener datos del sistema o como usarlos para una pequeña demo

Ejecutando las pruebas

Explica como ejecutar las pruebas automatizadas para este sistema

Analice las pruebas de extremo a extremo

Explica que comprueban estas pruebas y por qué

Da un ejemplo

Y las pruebas de estilo de codificación

Explica que comprueban estas pruebas y por qué

Da un ejemplo

Despliegue

Agrega notas adicionales sobre como desplegar

Construido con

  • Dropwizard - El framework web usado
  • Maven - Manejador de dependencias
  • ROME - Usado para generar RSS

Contribuyendo

Por favor lee el CONTRIBUTING.md para detalles de nuestro código de conducta, y el proceso para enviarnos pull requests.

Versionado

Usamos SemVer para el versionado. Para todas las versiones disponibles, mira los tags en este repositorio.

Autores

También puedes mirar la lista de todos los contribuyentes quíenes han participado en este proyecto.

Licencia

Este proyecto está bajo la Licencia MIT - mira el archivo LICENSE.md para detalles

Expresiones de Gratitud

  • "Un billete en el sombrero", para todos aquellos que aportaron código
  • Inspiración
  • etc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment