
Tips para hacer un buen readme.md
- Lo primero es que tengas una buena estructura del contenido que vas a mostrar, ordenada y con una secuencia paso a paso que haga más fácil la navegación por el sitio.
- No la llenes de tantas imágenes, inserta las que sean necesarias y controla el tamaño, pues estas se adaptan al 100% de ancho y pueden llegar a ser muy invasivas visualmente.
- Controla la longitud, no escribas un gran libro recuerda que es solo un pequeño manual de uso y contexto de lo que está dentro del repositorio. Para documentaciones más completas y detalladas te recomiendo que lo hagas en https://www.gitbook.com/ y luego lo cites.
- No olvides explicar cómo echar a andar tu proyecto para aquellos que no saben qué configuración o dependencias adicionales requieren.
- Cita las fuentes de donde te basaste, en caso de no aplicar, cita aquellos sitios que pueden complementar tu contenido.
- Haz buen uso de los titulos, subtitulos, subrayados, negritas y cursivas. Si defines un formato estándar llamarás más la atención.
- De preferencia escríbelo en inglés, esto le dará un mayor alcance a tus visitantes, o coloca partes importantes en máximo 2 idiomas que consideres importantes para que se accesible a todos.
- Si tienes varias ramas de trabajo, indica qué contiene cada una y cuál es la diferencia entre ellas, aclarar esto va a evitar que ignoren diferentes ramas de trabajo que pueden contener cosas importantes.
Puedes ver un ejemplo de un readme.md sencillo, práctico y limpio en un proyecto que he creado sólo para hacer readme's https://github.com/anabelisam/readme.md Además, en todos los demás proyectos que tengo en mi cuenta puedes ver sus diferentes portadas para cada tipo de proyecto.
Si sigues estos consejos y le pones tu marca personal a tus portadas, seguramente vas a atraer más visitantes y personas interesadas en tus proyectos, además si este es tu portafolio hablará muy bien de ti y demostrarás que eres una persona que se toma en serio sus proyectos personales y que es muy organizada.