Cómo escribir un archivo README para tu proyecto de GitHub

¿Por qué necesito un buen archivo README?

Un archivo README es una guía que brinda a los usuarios una descripción detallada de un proyecto en tu repositorio.
Quizás se esté preguntando por qué debería dedicar tiempo a escribir un archivo README. Bueno, hay algunas razones para ayudarlo a convencerse de que es una buena idea:

Ayuda a que sus proyectos se destaquen entre muchos otros. Debería ser tan bueno como el proyecto en sí.

Es el primer archivo que verá una persona al encontrar tu proyecto, por lo que debe ser bastante breve pero detallado.

Le ayudará a concentrarse en lo que su proyecto necesita entregar.

Qué, cómo y por qué

No existe una forma correcta de estructurar un archivo README. Pero hay algo que no puedes hacer, no incluir un archivo README.
Un archivo README debe responder al siguiente qué, cómo y por qué:

¿Cuál fue tu motivación?

¿Por qué construiste este proyecto?

¿Qué problema soluciona?

¿Cómo lo soluciona?

¿Qué aprendiste?

¿Qué hace que su proyecto se destaque?

Ahora sí, ¡empecemos!

Estos son los pasos que debe seguir para escribir un archivo README.

Incluya el título de su proyecto

Este es el nombre del proyecto. Describe todo el proyecto en una frase y ayuda a las personas a comprender cuál es el objetivo principal.

Escriba una descripción

La descripción es un aspecto extremadamente importante de tu proyecto. Una descripción bien elaborada le permite mostrar bien el trabajo a los usuario.
Este es un componente importante del proyecto que muchos desarrolladores nuevos a menudo pasan por alto.
La calidad de una descripción README a menudo diferencia un buen proyecto de un mal proyecto. Uno bueno aprovecha la oportunidad para explicar y mostrar:

Qué hace tu aplicación.

Por qué usó las tecnologías que usó.

Los desafíos que enfrentó y características que espera implementar en el futuro.

Un buen archivo README te ayuda a destacar entre la gran cantidad de desarrolladores en GitHub.

Agregar una tabla de contenido

Si el archivo README es muy extenso, es posible que desee agregar una tabla de contenido para que a los usuarios les resulte más fácil encontrar lo que necesitan.

Cómo instalar el proyecto

Si su proyecto es un software o una aplicación que necesita instalación, debe incluir los pasos necesarios para instalar su proyecto. Proporcione una descripción paso a paso de cómo hacer que el entorno de desarrollo funcione.

Cómo utilizar el proyecto

Proporcione instrucciones y ejemplos para que los usuarios puedan utilizar el proyecto. Esto les facilitará las cosas en caso de que encuentren un problema; siempre tendrán un lugar de referencia.

Incluir créditos

Si trabajó en el proyecto como un equipo o una organización, enumere sus colaboradores o miembros del equipo. También debe incluir enlaces a sus perfiles de GitHub.

Licencia del proyecto

Esta es la última sección de la mayoría de archivos README. Permite a otros desarrolladores saber lo que pueden y no pueden hacer con su proyecto.

Conclusión

¡Esos son los pasos principales que necesitas para escribir tu README!

Si has leído hasta aquí, ¡te lo agradezco mucho!