El readme es un archivo descriptivo del proyecto y el archivo de entrada de documentación para cualquier proyecto en su respectivo repositorio.
Este documento es obligatorio para todos los repositorios de la DSIT, es responsabilidad del equipo desarrollador mantenerlo actualizado. El readme debe contener al menos el siguiente listado de elementos:
- Nombre o título del proyecto
- Resumen o descripción del proyecto
- Prerrequisitos
- Instalación
- Como utilizar
- Wiki
- Contribuyentes
- Soporte
- Versión
- Autores
- Información de licencia
- Estado del proyecto
Utilice el siguiente template para la creación de su README: Template README