La importancia del Readme.md y como construirlo

Muchos desarrolladores suelen tener muchos proyectos en repositorios de git en servicios como GitHub, Bitbucket o GitLab. Es normal ver que en la gran mayoría de estos proyectos que existe un archivo Readme.md en blanco o hasta es inexistente, es por eso que te voy a hablar un poco sobre su importancia y como puedes construir tu primer Readme.md.

¿Que es el archivo Readme.md?

Este archivo es donde se coloca información pertinente sobre tu proyecto, versión en la que se encuentra actualmente, como debe desplegarse, como contribuir, que requisitos debes complicar para su uso, entre otras cosas.

Importancia

Siempre es recomendable que tengas una buena documentación en tus proyectos y este fichero no es una excepción, te recomiendo que vayas actualizando tu readme a medida que tu proyecto avanza y detalles la información necesaria para su uso.

Si es un proyecto open source es casi obligatorio esta documentación ya que sera la puerta de entrada para futuros contribuyentes y hacer crecer la comunidad que necesitas para que tu proyecto prospere.

Ejemplo de un Readme.md

Podemos observar en proyectos muy populares en las diferentes comunidades de desarrolladores que cuentan con un buen readme, por ejemplo el repositorio de React.js de Facebook:

Imagen de Github/Facebook

Markdown = .md

Markdown es un lenguaje de marcado ligero con el cual se puede construir una estructura html enriquecida dándole una visual más agradable, es por eso que se utiliza este formato en los proyectos git.

Para utilizar el formato Markdown aquí te dejo la sintaxis para que puedas empezar:

Información sacada de Packetlife.net

Plantilla Readme.me

Les dejo una plantilla para que la reutilicen en sus proyectos, de esta forma añaden un plus que sera de mucha ayuda cuando trabajen en equipo:

Recomendaciónes

Para finalizar te recomiendo lo siguiente:

  • Si no haz creado un reame te recomiendo que empieces de una vez y crees tu primer readme en algún proyecto que tengas en git. Si quieres utiliza la plantilla que te compartí y adaptala con la información de tu proyecto.
  • Personaliza y añade mas secciones a tu reame para que sea increíble.
  • Puedes basarte en proyecto populares como el que mencione en este post.

Si tienes alguna pregunta o sugerencia no dudes en dejarlo en los comentarios y lo tomaremos en cuenta.

Deja un comentario

es_ESEspañol