Una plantilla para hacer un buen README.md. Inspirado en el gist de @PurpleBooth => https://gist.github.com/PurpleBooth/109311bb0361f32d87a2

README-español.md

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

• Andrés Villanueva - Trabajo Inicial - villanuevand
• Fulanito Detal - Documentación - fulanitodetal

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 😊

Muy buen ejemplo, agradecido por compartir

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

Gracias amigo

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

Muchas gracias, me quedan claras muchas cosas.

Muchas gracias, si les fue de utilidad no olviden agregar una estrella ....
Exitos en sus proyectos. @gerMdz @drake222333 @LuisHex @JOSELUISOCHOAG @Jesus-Puertos @yeisonmarinramirez @Luhiz89

La estrella estuvo agregada desde el principio. Buen trabajo el tuyo.

Muchas gracias por la plantilla, buen trabajo

Estoy ampliamente agradecido con los creadores de esta plantilla, me encontraba realizando mis README desde cero y tardaba mucho haciendo la descripción de mis proyectos, ahora el tiempo en mínimo

@gerMdz @aurep-pmo @PabloGarzonB0 Gracias a todos por los comentarios y la buena vibra.
éxitos en sus proyectos!

Cordial saludo: La plantilla facilita la documentación de un proyecto de software. Muchas gracias!!

…

________________________________ De: PabloGarzón ***@***.***> Enviado: domingo, 4 de agosto de 2024 8:33 Para: PabloGarzonB0 ***@***.***> Cc: Comment ***@***.***> Asunto: Re: Villanuevand/README-español.md @PabloGarzonB0 commented on this gist.

________________________________ Estoy ampliamente agradecido con los creadores de esta plantilla, me encontraba realizando mis README desde cero y tardaba mucho haciendo la descripción de mis proyectos, ahora el tiempo en mínimo — Reply to this email directly, view it on GitHub<https://gist.github.com/Villanuevand/6386899f70346d4580c723232524d35a#gistcomment-5143382> or unsubscribe<https://github.com/notifications/unsubscribe-auth/BB5NKN6LBSVRAZHAMNG4ORLZPYUR3BFKMF2HI4TJMJ2XIZLTSKBKK5TBNR2WLJDUOJ2WLJDOMFWWLO3UNBZGKYLEL5YGC4TUNFRWS4DBNZ2F6YLDORUXM2LUPGBKK5TBNR2WLJDHNFZXJJDOMFWWLK3UNBZGKYLEL52HS4DFVRZXKYTKMVRXIX3UPFYGLK2HNFZXIQ3PNVWWK3TUUZ2G64DJMNZZDAVEOR4XAZNEM5UXG5FFOZQWY5LFVA4DKNBYGI2TMMVHORZGSZ3HMVZKMY3SMVQXIZI>. You are receiving this email because you commented on the thread. Triage notifications on the go with GitHub Mobile for iOS<https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android<https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.

________________________________ AVISO LEGAL: Este correo electrónico contiene información confidencial de ETB. Si Usted no es el destinatario, le informamos que no podrá usar, retener, imprimir, copiar, distribuir o hacer público su contenido, de hacerlo podría tener consecuencias legales como las contenidas en la Ley 1273 del 5 de Enero de 2009 y todas las que le apliquen. Si ha recibido este correo por error, por favor infórmenos a ***@***.*** y bórrelo. Si usted es el destinatario, le solicitamos mantener reserva sobre el contenido, los datos o información de contacto del remitente y en general sobre la información de este documento y/o archivos adjuntos, a no ser que exista una autorización explícita. LEGAL NOTICE: This e-mail transmission contains confidential information ETB. If you are not the intended recipient, you should not use, hold, print, copy, distribute or make public its content, on the contrary it could have legal repercussions as contained in Law 1273 of 5 January 2009 and all that apply .If you have received this e-mail transmission in error, please inform us at ***@***.*** and erase it. If you are the intended recipient, we ask you not to make public the content, the data or contact information of the sender and in general the information of this document or attached file, unless a written authorization exists.