¿Cómo crear un README?

Crea READMEs claros y cuéntale al mundo lo asombroso de tu proyecto.

Humberto López

Hace 3 años2 minutos de lectura

¿Cómo crear un buen README?

El archivo README es la carta de presentación de tu repositorio en GitHub, le ayuda a cualquier usuario para conocer la finalidad del repositorio o que contiene, muchas veces es olvidado y debería ser un most to have, con estos 5 tips crearás READMEs claros y útiles.

Descripción

Creaste tu proyecto para algún fin, informa cuál es a las personas, quizá creaste una biblioteca revolucionaria, pero si nadie sabe que ese repositorio le puede cambiar la vida, no navegaran.

Agrega Diseño

Un poco de diseño puede ayudarte a darle personalidad y diferencias tu repositorio, puedes añadir tu logo o crear un banner a la medida.

Instrucciones

Hay proyectos que requieren instalaciones específicas, hazle saber al usuario el paso a paso de la instalación y un ejemplo de como empezar a utilizar tu proyecto.

Instrucciones de instalación

Ejemplos

Depende el proyecto que tengas alojado puedes agregar demos o imágenes del proyecto final, pero es importante añadir un ejemplo de que hace o como luce tu proyecto.

Demo de un proyecto

¿Cómo contribuir?

Hay muchos proyectos OpenSource dispuestos a recibir contribuciones, pero sino lo comunicas, no hay manera que pase, no dejes que eso te pase y siempre deja tu guía de contribución, crea issues que la gente pueda asignarse y tus datos de contacto para cualquier duda extra.

Guía de contribución

Licencia

En proyectos OpenSource es muy importante agregar una licencia, básicamente le indicas a la gente los límites del uso de tu código, no dejes ambigueadades en este punto.

¿No sabes que licencia escoger? GitHub creo una herramienta para ayudarte: choosealicense

Una de las más comunes es la licencia MIT conoce sus permisos y limitaciones aquí.