Tips READMEs 1: secciones

• Nombre del proyecto
• Descripción: Importancia del proyecto, lo que hace.
• Indice: Si es largo o detallado, incluir una TOC.
• Instalación: ¿Cómo instalo el proyecto? Incluir GIF.
• Uso: ¿Cómo uso esto? Ej. de código, screenshots, link a otros docs.
• Contribuciones: Cómo contribuir al proyecto
• Créditos: Autores, colaboradores, inspiraciones..
• Licencia

Ver Formatting your README

Buenos READMEs

• Completo y estructurado: https://github.com/jkbrzt/httpie
• Rápido y fácil: https://github.com/karan/joe o https://github.com/rstacruz/hicat
• Orientado al uso: https://github.com/shama/gaze
• Geniales esquemas: https://github.com/b4b4r07/dotfiles

Ver A curated list of awesome READMEs

Tips READMEs 2:

1. Write an example, right now!
2. Describe the install procedure.
3. Stub out the API docs.
4. Tests*: how to run them
5. Licensing and Contributors
6. But I had other stuff to say!*: Write a blog post about it

Ver How To Write A Readme

Tips READMEs 3: random tips

• Usar GIFs: son cool y explican mucho en poco
• Mostrar código, rápido: los devs quieren ver código y ejemplos al toque
• Use badges: dicen mucho sobre el estado del proyecto en no-space

Hagamos nuestro template!!!

Como este: https://gist.github.com/PurpleBooth/109311bb0361f32d87a2

que es mejor que este: https://gist.github.com/jxson/1784669

Tips Repos

• Tener uno o más templates para tipos de proyectos distintos puede ser una buena idea

Ver Project Template como ejemplo de un template para proyectos de apertura de datasets

• Tipos de repos que puede haber en un Github. Ver Tipos de repos de Sunlight

Buenos Repos