Soñamos construir una infraestructura de herramientas, documentación, técnicas y configuraciones que nos permita desarrollar software embebido de calidad, con facilidad de replicación, modularidad y con un proceso de desarrollo establecido.
- Crear tu propio código reusable, (No empezar de cero cada vez)
- Organizar tu proyecto (dónde va qué cosa)
- Tener un proceso de desarrollo (cómo configurar tus compilaciones, pruebas y desplegue)
- Reusar periféricos y técnicas implementados en industria (mejoras tu CV y no reinventas la rueda)
- Tener cierta independencia de hardware en el código
El cómo vamos a lograr ésto está estipulado en el archivo de versiones.md donde se explica:
- Lógica de versionamiento
- Reglas de colaboración con ramas en github
- Propuesta de funcionalidades por versión
Algunos ejemplos de aplicación de los principios se pueden consultar aqui
- Reusabilidad
- Estandarización de un proceso de desarrollo
- Mantenibilidad
❕ Necesitamos ayuda para conseguirle un SSL a nuestro subdominio de documentación!
Se puede acceder desde el sitio framework.codepretzel.org
La documentación está dividida en secciones:
- Estructura, componentes y herramientas del framework
- Instalación, dependencias y requerimientos
- API
- Ejemplos de código de aplicación
- Scripts de configuración, integración y automatización
- Cómo contribuir al framework
- Actualización de la documentación
- Agregar/Editar secciones y contenido al proyecto de Sphynx
- Generar documentación de código con Doxygen y Breathe
- Procedimiento para crear nuevas ramas y Pull Requests
- Actualización de la documentación