README? Léeme, ¿qué sería eso? El README es un archivo con extensión .md, es decir, está escrito en Markdown, que es un lenguaje de marcado utilizado para convertir texto en HTML válido.
En plataformas de repositorios remotos como GitHub, la función de este archivo es presentar información del proyecto, como:
Descripción de su proyecto; funcionalidades; Cómo pueden usarlo los usuarios; Donde los usuarios pueden encontrar ayuda sobre su proyecto; Autores del proyecto. ¿Por qué hacer un README? Después de que hayas trabajado duro y desarrollado un proyecto genial, probablemente estarás subiendolo a GitHub y mostrando a la comunidad lo que has hecho.
Para eso, es bueno documentar el proyecto para que quien visite tu repositorio sepa de qué se trata, como lo vimos en el primer ejemplo.
Y eso lo podemos hacer a través del README, que es el primer archivo que se ve, es decir, es la puerta de entrada a tu proyecto. El propio GitHub hace esta recomendación a la hora de subir un proyecto sin este archivo:
i-03 Traducción: Ayude a las personas interesadas en este repositorio a comprender su proyecto agregando un README.
Además, algunas personas utilizan el perfil de GitHub como portafolio, si es tu caso, es interesante apostar por los archivos README para hacer más atractivos tus proyectos incluso para los reclutadores. Si este no es tu objetivo, vale la pena señalar que no siempre queremos que los usuarios se interesen o colaboren con nuestro repositorio, en estos casos no es necesario utilizar este archivo.
