Cuál es la importancia del README

¿Sabes cuál es la importancia del README? ¡En este post te la contamos! En casi todos los repositorios de proyectos de código que has revisado, seguramente te habrás encontrado con un texto que se titula README y va acompañado de una extensión específica, que puede ser txt ( es decir, de un texto plano, tal como un bloc de notas de tu ordenador o un texto escrito sobre papel), .md (un texto en formato Markdown) u otras extensiones, como .me o .1st. Si quieres saber cuál es la importancia del README y cómo crear este archivo, te recomendamos seguir leyendo este artículo.

Importancia del README

La importancia del README en los repositorios remotos de tus programas radica en llevar un registro sobre el contenido de tus programas para tu propio uso y, por otro lado, para el trabajo colaborativo entre otros programadores. De alguna manera, el archivo README le da una perfil a tus trabajos y es el primer paso para conocerlos y, después, utilizar el programa si es de tu preferencia.

Cómo crear el archivo README

En un principio, para crear el archivo README deberás tener creada una carpeta en tu ordenador y que, a su vez, esté abierta en el IDE de tu preferencia. En ese momento solo debes crear un archivo más dentro de esta carpeta y titularlo README. Después de ello, deberás preguntarte por la forma o formato en la que quieres presentar tu texto. Puede ser de forma clásico, con un texto normal o utilizar un lenguaje de marcado de texto, como es el caso de MarkDown.

Para saber más acerca del lenguaje de marcado de texto MarkDown, puedes revisar un post anterior de KeepCoding en el que te hablamos acerca de qué es Markdown, cómo se utiliza y cuál es su funcionalidad.

Para refrescarte la memoria, debes saber que Markdown o MD, por sus siglas, es un lenguaje de mercado que posibilita adecuar el formato de tus textos para hacer su lectura mucho más amigable y, a su vez, útil para tus programas. También puedes usar este lenguaje de marcado en aplicaciones como Whastapp y Slack.

¿Qué debe caracterizar a una archivo README?

Ahora que conoces la importancia del README, estos son algunos puntos claves fundamentales que debes añadir en tu archivo README y que podemos ver en muchos repositorios que se encuentran en Github y GitLab. Ambos repositorios son lugares remotos para guardar el control de versiones de tus programas y llevar un historial de ellas, te permiten compartir tu programa y trabajar de forma colaborativa.

Estas características son:

• El primer punto clave es añadir el título de tu programa. De esta forma, la persona que lo visita puede hacerse una idea nada más verlo. Si le interesa, seguirá leyendo el texto.
• El segundo punto que debería tener tu archivo README es el aparte de la descripción, en donde podrías agregar respuestas a dos preguntas importantes sobre cada repositorio de un programa: cuál es el problema o situación que resuelve el programa o qué hace el repositorio.
• Otro punto necesario en tu repositorio es que comentes cómo se utiliza el programa, es decir, qué se necesita para activarlo o qué pasos hay que completar para hacer que funcione.
• Otro aspecto necesario en el texto de los repositorios es que enumeres todos lenguajes con los que se ha trabajado en el programa. Esto es importante por si quien revisa el repositorio de tu programa es experto en un lenguaje de programación.
• Por último, es importante mencionar al autor o autores (con sus respectivas cuentas de repositorios remotos) para, primero, brindarles crédito y, a su vez, poder visitar otros repositorios por si te interesan los programas de una misma índole.

De esta manera, al haber comprobado cada uno de estos puntos, el texto README de tu programa de código estará listo para integrarlo en cada uno de los repositorios. Esperamos que cada uno de estos textos permita que vuelvas y recuerdes fácilmente la propuesta de los programas de código. Además, permite el trabajo colaborativo, que es muy importante en el mundo de la programación y el pensamiento computacional.

¿Qué puedes hacer ahora?

Ya que sabes cuál es la importancia del README y cómo crear este archivo, estás listo para integrar este documento a tus repositorios locales y remotos, pues funciona como guía para ti y otros programadores que estén buscando plantillas o inspiración para proyectos propios.

Si quieres conocer más acerca del mundo del código, del pensamiento computacional y de diferentes lenguajes de programación, te recomendamos empezar un curso que se dicte desde cero, para asentarte sobre unas bases sólidas y, a partir de ahí, continuar aprendiendo y especializándote. Por eso, te recomendamos apuntarte a nuestro Aprende a Programar desde Cero Full Stack Jr. Bootcamp, con el que podrás empezar en el camino del código desde cero. ¡Apúntate ya!