Issue de revisión de documentación: #94
Description
Este issue forma parte de un proceso de revisión de la piloto @BID-COMUNIDADES/laboratoria-code-squads de la iniciativa Código para el desarrollo de @EL-BID. @ChayoVS.
Al haber contrastado la información presentada en el repo oficial con los campos solicitados en la plantilla de readme.md https://github.com/EL-BID/Plantilla-de-repositorio/blob/master/README.md hemos encontrado los siguientes puntos a mejorar:
-
Descripción y contexto: Descripción de las funcionalidades.
-
Guía de usuario: (Paso a paso dirigido al usuario final sobre cómo empezar a usar la herramienta digital).
-
Guía de instalación:
1. Los requisitos del sistema operativo para la compilación (versiones específicas de librerías, software de gestión de paquetes y dependencias, SDKs y compiladores, etc.). 2. Las dependencias propias del proyecto, tanto externas como internas (orden de compilación de sub-módulos, configuración de ubicación de librerías dinámicas, etc.). 3. Pasos específicos para la compilación del código fuente y ejecución de tests unitarios en caso de que el proyecto disponga de ellos. -
Autores: Sección para dar créditos a los colaboradores de la herramienta.
-
Licencia para el código de la herramienta: Permisos que se otorgan a terceros para reutilizar la herramienta digital. Debe especificar el tipo de licencia y hacer referencia al archivo license.txt o licencia.txt con el contenido de la licencia.
-
Licencia para la documentación de la herramienta: Recomendamos el uso de las licencias creative commons para el licenciamiento de la documentación de las herramientas. La CC0-1.0, CC-BY-4.0 y CC-BY-SA-4.0 por ejemplo son licencias abiertas que se utilizan para material que no es de software, desde conjuntos de datos hasta videos. Tenga en cuenta que CC-BY-4.0 y CC-BY-SA-4.0 no deben usarse para el software.
Secciones se pueden añadir para acabar de completar la documentación
- Cómo contribuir: Sección que explica a nuevos desarrolladores el proceso para contribuir a proyectos.
- Código de conducta: El código de conducta establece las normas sociales, reglas y responsabilidades que los individuos y organizaciones deben seguir al interactuar de alguna manera con la herramienta digital o su comunidad. Es una buena práctica para crear un ambiente de respeto e inclusión en las contribuciones al proyecto. La plataforma Github premia y ayuda a los repositorios que dispongan de este archivo. Al crear CODE_OF_CONDUCT.md puedes empezar desde una plantilla sugerida por ellos. Aquí tienes una plantilla propuesta por Contributor Convenant que puedes usar para tu proyecto.
-[ ] Insignias (badges): Las insignias (badges) pequeñas imágenes incrustadas en el README.md que especifican de una manera legible y concisa el estado de la herramienta. Existen insignias para el estado de desarrollo, el número de descargas, el versionado, sociales u otras. En este link podrás encontrar información https://shields.io/
-[ ] Versión: Indica un listado de las versiones de las herramientas digital y las funcionalidades añadidas a cada versión. - Reconocimientos: Reconocimientos a otras personas u organizaciones que hayan contribuido de alguna forma al proyecto