Ya debes haber instalado algún software que contenía un archivo en .txt en una de sus carpetas con el nombre Readme. Bueno, este archivo significa literalmente ‘’Léame’’, y contiene instrucciones que generalmente son para que tú sepas como hacer la instalación del software.
En proyectos de GitHub, el Readme es un archivo con una extensión .md (Markdown) que contiene las informaciones necesarias para entender el objetivo y el estado de tu proyecto. Markdwon es un lenguaje de marcación de texto, así como HTML, pero más simple. ¿Quiere saber más sobre Markdown? Paulo Silveira te explicará en este artículo.
Pero, ¿por qué necesito tener un Readme en el repositorio de mi proyecto?
En el Readme, puedes dar una descripción acerca de qué trata tu proyecto, cuál el estado actual de él, las tecnologías utilizadas, el equipo que trabaja en el desarrollo, como contribuir (se es un proyecto open source), como usar, etc. Existe una gran posibilidad de cosas que puedes poner en tu readme con el objetivo de informar y ser lo más atractivo y organizado posible para quien esté visualizando tu proyecto.
Y para ayudarte en esta tarea de personalizar tu Readme, Camila Fernanda Alves escribió un artículo increíble que te mostrará cómo escribir un excelente Readme para tu proyecto.
