Skip to content

Instantly share code, notes, and snippets.

@Villanuevand
Last active March 20, 2024 01:26
Show Gist options
  • Save Villanuevand/6386899f70346d4580c723232524d35a to your computer and use it in GitHub Desktop.
Save Villanuevand/6386899f70346d4580c723232524d35a 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 Deployment 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 end-to-end 🔩

Explica que verifican estas pruebas y por qué

Da un ejemplo

Y las pruebas de estilo de codificación ⌨️

Explica que verifican estas pruebas y por qué

Da un ejemplo

Despliegue 📦

Agrega notas adicionales sobre como hacer deploy

Construido con 🛠️

Menciona las herramientas que utilizaste para crear tu proyecto

  • 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.

Wiki 📖

Puedes encontrar mucho más de cómo utilizar este proyecto en nuestra Wiki

Versionado 📌

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

Autores ✒️

Menciona a todos aquellos que ayudaron a levantar el proyecto desde sus inicios

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

Licencia 📄

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

Expresiones de Gratitud 🎁

  • Comenta a otros sobre este proyecto 📢
  • Invita una cerveza 🍺 o un café ☕ a alguien del equipo.
  • Da las gracias públicamente 🤓.
  • Dona con cripto a esta dirección: 0xf253fc233333078436d111175e5a76a649890000
  • etc.

⌨️ con ❤️ por Villanuevand 😊

@RuloGB
Copy link

RuloGB commented Jan 20, 2023

Que buen trabajo, gracias!

@Villanuevand
Copy link
Author

@ErickBorgesGalindo @demavares @cteves1 @JonnyCano-ValorGanado @RuloGB Me alegra que les haya gustado! Ojala les sea de mucha utilidad.

@gerMdz
Copy link

gerMdz commented Mar 23, 2023

Excelente

@drake222333
Copy link

Gracias, me ayudo bastante en mi proyecto

@LuisHex
Copy link

LuisHex commented Jun 6, 2023

¡Genial tu plantilla, muchas gracias por compartir!

@caeduardo99
Copy link

Practico y minimalista muchas gracias crack

@dbriceno10
Copy link

Excelente plantilla. Muchas gracias!

@JOSELUISOCHOAG
Copy link

Muy buen ejemplo, agradecido por compartir

@stunlocked1
Copy link

congratulations for you have managed to become the owner of the most starred gist that contains the word "sus"!

@Jesus-Puertos
Copy link

Gracias amigo

@yeisonmarinramirez
Copy link

Genial amigo, muchas gracias por contribuir al aprendizaje!!!...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment