Proporcione una breve descripción que explique el qué, el por qué y el cómo de su proyecto. Utilice las siguientes preguntas como guía:
-
¿Cuál fue su motivación?
-
¿Por qué desarrolló este proyecto? (Nota: La respuesta no es “Porque fue una asignación de tarea”.)
-
¿Qué problema resuelve?
-
¿Qué aprendió?
Si su README es extenso, agregue un índice para facilitar que los usuarios encuentren lo que necesitan.
¿Cuáles son los pasos necesarios para instalar su proyecto?
Proporcione una descripción paso a paso de cómo poner en funcionamiento el entorno de desarrollo.
Proporcione instrucciones y ejemplos de uso. Incluya capturas de pantalla según sea necesario.
Para agregar una captura de pantalla, cree una carpeta assets/images en su repositorio y cargue la captura de pantalla en ella. Luego, con la ruta relativa, agréguela a su README utilizando la siguiente sintaxis:
Enumere sus colaboradores, si los hubiera, con enlaces a sus perfiles de GitHub.
Si utilizó activos de terceros que requieren autoría, enumere los creadores con enlaces a su presencia web principal en esta sección.
Si siguió tutoriales, también incluya enlaces a ellos aquí.
La última sección de un archivo README de alta calidad es la licencia. Esto permite que otros desarrolladores sepan lo que pueden y no pueden hacer con su proyecto. Si necesita ayuda para elegir una licencia, consulte https://choosealicense.com/.
🏆 Las secciones anteriores son lo mínimo indispensable y su proyecto determinará finalmente el contenido de este documento. También puede considerar agregar las siguientes secciones.
Las insignias en sí mismas no son necesarias, pero demuestran un crédito callejero. Las insignias permiten a otros desarrolladores saber que usted sabe lo que está haciendo. Eche un vistazo a las insignias presentadas por shields.io. Es posible que no comprenda lo que todas ellas representan ahora, pero lo comprenderá con el tiempo.
Si su proyecto tiene muchas funciones, enumérelas aquí.
Si creó una aplicación o paquete, y desea que otros desarrolladores contribuyan con ella, puede incluir directrices sobre cómo hacerlo. El Pacto de colaboradores es un estándar de la industria, pero siempre puede redactar el suyo si lo prefiere.
Vaya un paso más allá y escriba pruebas para su aplicación. Luego, proporcione ejemplos sobre cómo ejecutarlas aquí.