README restructuré : balises et instructions pour les voyageurs du système.

Ajout de motifs expérimentaux dans la documentation.
Navigation optimisée, mais bruit de fond garanti.
Les modules suivent désormais une logique dystopique.
ManuReadMe : à lire pour ne pas se perdre dans la cacophonie
This commit is contained in:
Clément SAILLANT
2026-02-19 06:17:35 +01:00
parent 86cf9bc792
commit 9734c88165
+89 -130
View File
@@ -1,5 +1,4 @@
# Kill_LIFE 🚀 — AI-Native Embedded Project Template
# Kill_LIFE 🚀 — Modèle de Projet Embarqué IA-Natif
<!-- Badges personnalisés -->
[![Build Status](https://img.shields.io/github/actions/workflow/status/electron-rare/Kill_LIFE/ci.yml?branch=main)](https://github.com/electron-rare/Kill_LIFE/actions)
@@ -7,86 +6,68 @@
[![Compliance](https://img.shields.io/badge/compliance-passed-brightgreen)](docs/COMPLIANCE.md)
[![Coverage](https://img.shields.io/badge/coverage-90%25-brightgreen)](docs/coverage_report.html)
---
## Sommaire
Bienvenue dans **Kill_LIFE**, le modèle open source pour systèmes embarqués IA où chaque étape est traçable, chaque evidence pack est rangé, et chaque agent suit un workflow sécurisé. Ce projet vise la reproductibilité, la conformité et lautomatisation pour lembarqué IA multi-cibles.
## 🧩 Présentation
Kill_LIFE est un modèle agentique pour systèmes embarqués IA, orienté spec-first, sécurité et traçabilité. Il sappuie sur des agents spécialisés, des workflows automatisés et une arborescence claire.
> « Bienvenue dans le meilleur des mondes : ici, chaque commit est validé, chaque gate est passé, et chaque agent sait que la vraie liberté, cest davoir un evidence pack bien rangé. »
> — Aldous Huxley, version CI/CD
<div align="center">
<img src="docs/assets/banner_kill_life_generated.png" alt="Kill_LIFE Banner" width="600" />
<img src="docs/assets/banner_kill_life_generated.png" alt="Bannière Kill_LIFE" width="600" />
</div>
<div align="center" style="margin: 8px 0;">
<img src="docs/assets/dont_panic_generated.png" alt="Dont Panic" width="120" style="vertical-align:middle;margin:0 4px;" />
<a href="https://www.youtube.com/playlist?list=PLApocalypse42" target="_blank">Playlist apocalypse</a>
</div>
Bienvenue dans **Kill_LIFE**, le template open source pour systèmes embarqués IA, où chaque étape est traçable, chaque evidence pack est rangé, et chaque agent suit un workflow sécurisé. Ce projet vise la reproductibilité, la conformité, et lautomatisation pour lembarqué IA multi-cibles.
> "La réponse à la question ultime de la vie, de lunivers et du développement embarqué IA: 42 specs, 7 agents, et un pipeline qui ne panique jamais."
> "Kill_LIFE, cest lopen source embarqué version IA, mais aussi un clin d’œil à la fin du monde: ici, on ne craint ni lapocalypse, ni les bugs, ni les injections de prompt. On rêve, on code, on documente, et on fait des bulk edits comme des réplicants en quête de compliance."
> — Le README qui ne panique jamais
## 🚦 Quickstart
1. Clone le repo et installe les dépendances ([INSTALL.md](INSTALL.md)).
2. Initialise un environnement Python (venv ou conda) et PlatformIO.
3. Lance les scripts de validation (Makefile, tools/).
4. Ouvre une issue, ajoute un label `ai:*` pour déclencher lautomatisation.
5. Suis le flux Issue → PR, gates, evidence pack.
6. Vérifie la conformité via les scripts de compliance.
Pour plus de détails, consulte [docs/index.md](docs/index.md), [RUNBOOK.md](RUNBOOK.md), [INSTALL.md](INSTALL.md).
## 🧩 Présentation
Kill_LIFE est un template agentique pour systèmes embarqués IA, orienté spec-first, sécurité, et traçabilité. Il sappuie sur des agents spécialisés, des workflows automatisés, et une arborescence claire.
<div align="center" style="margin: 8px 0;">
<img src="docs/assets/arborescence_kill_life_generated.png" alt="Arborescence du projet Kill_LIFE" width="400" />
</div>
---
## 🧩 Architecture & Principes
- **Spec-first** : Chaque évolution commence par une définition claire dans `specs/` ([Spec Generator FX](https://www.youtube.com/watch?v=9bZkp7q19f0)).
- **Standards injection** : Standards versionnés + profils injectés (Agent OS).
- **BMAD / BMAD-METHOD** : Agents par rôles (PM, Architect, Firmware, QA, Doc, HW), rituels, gates, handoffs ([agents/](agents/), [bmad/](bmad/)).
> _Schaeffer : Les agents du pipeline écoutent le bruit des specs comme une symphonie de sons trouvés._
- **Injection de standards** : Standards versionnés et profils injectés (Agent OS).
- **BMAD / BMAD-METHOD** : Agents par rôles (PM, Architecte, Firmware, QA, Doc, HW), rituels, gates, handoffs ([agents/](agents/), [bmad/](bmad/)).
<div align="center" style="margin: 8px 0;">
<img src="docs/assets/agents_bmad_generated.png" alt="Schéma des agents BMAD" width="400" />
</div>
- **Tool-first** : Scripts reproductibles ([tools/](tools/)), evidence pack dans `artifacts/`.
- **Pipeline hardware/firmware** : Bulk edits, exports, tests, compliance, snapshots ([Les particules font-elles lamour?](https://lelectron-fou.bandcamp.com/album/les-particules-font-elles-l-amour-la-physique)).
- [Fête technique](https://www.youtube.com/watch?v=dQw4w9WgXcQ) — robots IA dansant sur du code PCB.
- **Sécurité & conformité** : Sanitisation, safe outputs, sandboxing, scope guard, anti-prompt injection ([OpenClaw Sandbox](https://www.openclaw.io/)).
- **Pipeline hardware/firmware** : Bulk edits, exports, tests, conformité, snapshots.
- **Sécurité & conformité** : Sanitisation, sorties sûres, sandboxing, scope guard, anti-prompt injection ([OpenClaw Sandbox](https://www.openclaw.io/)).
> "Les particules rêvent-elles d’électron-ironique? Peut-être font-elles lamour dans le dossier hardware, pendant que les agents QA se demandent si la conformité est un rêve ou une réalité."
> — Inspiré par Le Réplicant de K. Dick & Les particules font-elles lamour
_« Jai vu des evidence packs briller dans lobscurité près des gates S1… »_
> « La réponse à la question ultime de la vie, de lunivers et du développement embarqué IA : 42 specs, 7 agents, et un pipeline qui ne panique jamais. »
> « Kill_LIFE, cest lopen source embarqué version IA, mais aussi un clin d’œil à la fin du monde : ici, on ne craint ni lapocalypse, ni les bugs, ni les injections de prompt. On rêve, on code, on documente, et on fait des bulk edits comme des réplicants en quête de conformité. »
> — Le README qui ne panique jamais
> "Bienvenue dans le meilleur des mondes: ici, chaque commit est validé, chaque gate est passé, et chaque agent sait que la vraie liberté, cest davoir un evidence pack bien rangé."
> — Aldous Huxley, version CI/CD
([Les particules font-elles lamour ?](https://lelectron-fou.bandcamp.com/album/les-particules-font-elles-l-amour-la-physique))
---
## ✨ Fonctionnalités principales
- **Développement guidé par la spec** : User stories, contraintes, archi, plans, backlog.
- **Développement guidé par la spec** : User stories, contraintes, architecture, plans, backlog.
- **Automatisation** : Issue → PR avec tests unitaires, sanitisation, evidence pack.
- **Multi-cibles** : ESP32, STM32, Linux, tests natifs.
- **Pipeline matériel** : KiCad, exports SVG/ERC/DRC/BOM/netlist, bulk edits.
- **Compliance** : Profils injectés, validation automatique.
<div align="center" style="margin: 8px 0;">
<img src="docs/assets/pipeline_hw_fw_generated.png" alt="Pipeline hardware/firmware" width="400" />
</div>
- **Conformité** : Profils injectés, validation automatique.
- **OpenClaw** : Labels & commentaires sanitisés, jamais de commit/push, sandbox obligatoire.
---
## 🖥️ Schéma agentique (Mermaid)
<div align="center">
@@ -94,11 +75,11 @@ _« Jai vu des evidence packs briller dans lobscurité près des gates S1
```mermaid
flowchart TD
Issue[Issue (label ai:*)] --> PR[Pull Request]
PR --> Gate[Gate (tests, compliance)]
PR --> Gate[Gate (tests, conformité)]
Gate --> Evidence[Evidence Pack]
Evidence --> CI[CI/CD]
CI --> Deploy[Déploiement multi-cible]
PR --> Agents[Agents (PM, Architect, Firmware, QA, Doc, HW)]
PR --> Agents[Agents (PM, Architecte, Firmware, QA, Doc, HW)]
Agents --> Specs[specs/]
Agents --> Firmware[firmware/]
Agents --> Hardware[hardware/]
@@ -114,6 +95,7 @@ flowchart TD
```
</div>
> _Parmegiani : Un bulk edit, cest une métamorphose électronique, un peu comme un pack d’évidence qui se transforme en nuage de sons._
---
@@ -127,29 +109,12 @@ Voir [KIKIFOU/mapping.md](KIKIFOU/mapping.md) pour une synthèse des dossiers et
---
## 🥚 Easter Eggs Kill_LIFE
> **Pierre Schaeffer** : _« Les agents du pipeline écoutent le bruit des specs comme une symphonie de sons trouvés. »_
> **Éliane Radigue** : _« Ici, chaque evidence pack vibre lentement, comme une onde analogique dans le silence du hardware. »_
> **Luc Ferrari** : _« Parfois, le firmware improvise, et cest toute la machine qui devient paysage sonore. »_
> **Daphne Oram** : _« Les gates sont modulés par lOramics de la conformité. »_
> **Bernard Parmegiani** : _« Un bulk edit, cest une métamorphose électronique, un peu comme un pack d’évidence qui se transforme en nuage de sons. »_
> **François Bayle** : _« Lespace du repo est acousmatique: on ne sait jamais doù viendra la prochaine spec. »_
> **Annea Lockwood** : _« Les tests hardware sont parfois submergés, comme un piano brûlé dans le sandbox. »_
> **Kiyoshi Yamaya** : _« Les artefacts du pipeline sont des fragments dun rêve sonore, dispersés dans le code. »_
> **Zbigniew Karkowski** : _« La conformité, cest parfois bruitiste: il faut oser saturer les scripts. »_
> **Hildegard Westerkamp** : _« Les agents QA écoutent le paysage du repo, à la recherche dun bug caché dans le souffle. »_
> **Yoshi Wada** : _« Parfois, le README résonne comme un drone, et tout le projet saccorde. »_
---
## 🚀 Installation & initialisation
### Prérequis
- OS : Linux, macOS, Windows (WSL)
- Python >= 3.8
- Python 3.8
- PlatformIO
- KiCad (hardware)
- Docker (optionnel)
@@ -162,27 +127,28 @@ cd Kill_LIFE
bash install_kill_life.sh
```
Suivre le guide [INSTALL.md](INSTALL.md) pour les détails.
Voir [INSTALL.md](INSTALL.md) pour les détails.
---
## 🤝 Contribuer
1. Fork le repo, clone-le localement.
2. Suis le guide onboarding ([docs/](docs/index.md), [RUNBOOK.md](RUNBOOK.md)).
1. Forke le dépôt et clone-le localement.
2. Suis le guide donboarding ([docs/index.md](docs/index.md), [RUNBOOK.md](RUNBOOK.md)).
3. Ajoute des exemples minimalistes pour chaque agent (voir [agents/](agents/)).
4. Propose des blocks hardware, profils compliance, tests.
4. Propose des blocks hardware, profils de conformité, tests.
5. Documente tes scripts et contributions.
6. Ouvre une PR, passe les gates, fournis un evidence pack.
7. Respecte les conventions de commit et de labelling (`ai:*`).
8. Vérifie la conformité et la sécurité (voir section Sécurité).
Pour toute question, consulte la [FAQ](docs/FAQ.md) ou ouvre une issue.
> « Les particules rêvent-elles d’électron-ironique ? Peut-être font-elles lamour dans le dossier hardware, pendant que les agents QA se demandent si la conformité est un rêve ou une réalité. »
> — Inspiré par Le Réplicant de K. Dick & Les particules font-elles lamour
_« Jai vu des evidence packs briller dans lobscurité près des gates S1… »_
---
## 🔗 Liens utiles
@@ -195,140 +161,133 @@ Pour toute question, consulte la [FAQ](docs/FAQ.md) ou ouvre une issue.
- [Mapping dossiers](KIKIFOU/mapping.md)
- [Gate Runner](https://gate-runner.com) — passe les gates, évite les bugs.
---
---
## 🛡️ Sécurité & conformité
- OpenClaw : sandbox obligatoire, jamais daccès aux secrets ou au code source.
- Workflows CI : validation, sanitisation, scope guard, anti-prompt injection.
- Evidence packs : tous les rapports dans `artifacts/<domain>/<timestamp>/`.
- Evidence packs : tous les rapports dans `artifacts/<domaine>/<timestamp>/`.
- Tests hardware reproductibles via scripts documentés.
- Respect des conventions de labelling et de commit.
---
---
## 🛠️ Fonctions clés
- **specs/** : Source de vérité, plans, backlog.
- **standards/** : Standards globaux, profils injectés.
- **bmad/** : Gates, rituels, templates.
- **agents/** : Prompts pour chaque rôle.
- **tools/** : Scripts AI, cockpit, compliance, watch.
- **tools/** : Scripts IA, cockpit, conformité, watch.
- **firmware/** : PlatformIO, tests Unity, multi-cibles.
- **hardware/** : KiCad, bulk edits, exports.
- **openclaw/** : Labels, commentaires, sandbox.
<div align="center" style="margin: 8px 0;">
<img src="docs/assets/openclaw_cicd_success.png" alt="OpenClaw CI/CD Success" width="100" style="vertical-align:middle;margin:0 4px;" />
<img src="docs/assets/openclaw_cicd_running.png" alt="OpenClaw CI/CD Running" width="100" style="vertical-align:middle;margin:0 4px;" />
<img src="docs/assets/openclaw_cicd_error.png" alt="OpenClaw CI/CD Error" width="100" style="vertical-align:middle;margin:0 4px;" />
<img src="docs/assets/openclaw_cicd_cancel.png" alt="OpenClaw CI/CD Cancel" width="100" style="vertical-align:middle;margin:0 4px;" />
<img src="docs/assets/openclaw_cicd_inactive.png" alt="OpenClaw CI/CD Inactive" width="100" style="vertical-align:middle;margin:0 4px;" />
</div>
<div align="center" style="margin: 8px 0;">
<img src="docs/assets/badge_42_generated.gif" alt="Badge 42" width="100" style="vertical-align:middle;margin:0 4px;" />
<a href="https://docs/assets/badge_42_generated.gif" target="_blank">Clique pour une blague mathématique</a>
<img src="docs/assets/bulk_edit_party_generated.png" alt="Bulk Edit Party" width="200" />
<img src="docs/assets/evidence_pack_generated.png" alt="Evidence Pack" width="200" />
<img src="docs/assets/gate_validation_generated.png" alt="Gate Validation" width="200" />
<img src="docs/assets/openclaw_sandbox_generated.png" alt="OpenClaw Sandbox" width="200" />
</div>
- **.github/** : Workflows CI, scope guard, enforcement labels.
- **licenses/** : MIT, CERN OHL v2, CC-BY 4.0.
---
---
## 🦾 Workflows agents
- **Scope guard** : Label détermine les dossiers modifiables.
2. Ouvre une issue avec le label `ai:spec`.
3. Lagent PM/Architect génère le plan et larchitecture.
4. Lagent Firmware implémente le code dans `firmware/`.
5. Lagent QA ajoute des tests Unity.
6. Evidence pack généré automatiquement.
> Générateur de phrases dystopiques pour motiver les contributeurs.
- **Scope guard** : Le label détermine les dossiers modifiables.
- Ouvre une issue avec le label `ai:spec`.
- Lagent PM/Architecte génère le plan et larchitecture.
- Lagent Firmware implémente le code dans `firmware/`.
- Lagent QA ajoute des tests Unity.
- Evidence pack généré automatiquement.
> Générateur de phrases dystopiques pour motiver les contributeurs.
- **Bulk Edit Hardware KiCad**
- **Documentation & Compliance**
- **Documentation & Conformité**
1. Ouvre une issue avec le label `ai:docs` ou `ai:qa`.
2. Lagent Doc met à jour `docs/` et le README.
3. Lagent Compliance valide le profil et génère le rapport.> Trouve la phrase supprimée par le sanitizer, score affiché.
> _« Un evidence pack peut-il rêver de conformité ? »_
3. Lagent Conformité valide le profil et génère le rapport.
> _RtFM: Les agents QA écoutent le paysage du repo, à la recherche dun bug caché dans le souffle._
> Trouve la phrase supprimée par le sanitizer, score affiché.
> _« Un evidence pack peut-il rêver de conformité ? »_
---
## 📝 Installation & Sécurité
Un guide dinstallation détaillé ([INSTALL.md](INSTALL.md)) explique comment installer le projet, configurer les environnements, sécuriser OpenClaw, lancer les tests hardware, générer la documentation, et utiliser Docker.
Un script dinstallation unique ([install_kill_life.sh](install_kill_life.sh)) automatise tout: dépendances, spec, profil compliance, environnement Python, modules AI/hardware/firmware, tests, doc, Docker, et vérification de la sécurité OpenClaw.
Sécurité OpenClaw: sandbox obligatoire, jamais daccès aux secrets ou au code source.
Un guide dinstallation détaillé ([INSTALL.md](INSTALL.md)) explique comment installer le projet, configurer les environnements, sécuriser OpenClaw, lancer les tests hardware, générer la documentation et utiliser Docker.
Un script dinstallation unique ([install_kill_life.sh](install_kill_life.sh)) automatise tout : dépendances, spec, profil de conformité, environnement Python, modules IA/hardware/firmware, tests, doc, Docker, et vérification de la sécurité OpenClaw.
Sécurité OpenClaw : sandbox obligatoire, jamais daccès aux secrets ou au code source.
Tests hardware reproductibles via scripts documentés.
---
## 🧬 Architecture agentique avancée
- Structure multi-agent (BMAD): rôles PM, Architect, Firmware, QA, Doc, HW, orchestrés par rituels, gates et handoffs.
- Développement spec-first: chaque évolution commence par une spécification, standards versionnés et profils injectés.
- Automatisation & sécurité: workflows CI, sanitisation, safe outputs, scope guard, anti-prompt injection, OpenClaw sandbox.
- Multi-cibles & pipelines reproductibles: ESP32, STM32, Linux, tests natifs, bulk edits hardware KiCad, exports automatisés.
- Documentation claire & onboarding: README détaillé, FAQ, workflows, arborescence graphique, guides dinstallation, politique de contribution.
- Structure multi-agent (BMAD) : rôles PM, Architecte, Firmware, QA, Doc, HW, orchestrés par rituels, gates et handoffs.
- Développement spec-first : chaque évolution commence par une spécification, standards versionnés et profils injectés.
- Automatisation & sécurité : workflows CI, sanitisation, sorties sûres, scope guard, anti-prompt injection, OpenClaw sandbox.
- Multi-cibles & pipelines reproductibles : ESP32, STM32, Linux, tests natifs, bulk edits hardware KiCad, exports automatisés.
- Documentation claire & onboarding : README détaillé, FAQ, workflows, arborescence graphique, guides dinstallation, politique de contribution.
---
## 🚀 Conventions, contribution & cross-platform
Toutes les conventions, instructions dinstallation, sécurité, multi-agents, compliance, workflows, et support cross-platform (Docker inclus) sont synthétisées.
> _RtFM : Parfois, le README résonne comme un drone, et tout le projet saccorde._
Toutes les conventions, instructions dinstallation, sécurité, multi-agents, conformité, workflows et support multi-plateforme (Docker inclus) sont synthétisées.
Architecture, étapes dinitialisation, fonctions clés, sécurité OpenClaw, contribution.
---
## ❓ FAQ
**Q : Comment démarrer rapidement ?**
A : Suis la section "Installation & initialisation" ou le guide INSTALL.md.
R : Suis la section « Installation & initialisation » ou le guide INSTALL.md.
**Q : Comment installer tout automatiquement ?**
A : Utilise le script `install_kill_life.sh`.
R : Utilise le script `install_kill_life.sh`.
**Q : Comment sécuriser OpenClaw ?**
A : Sandbox obligatoire, jamais daccès aux secrets ou au code source.
R : Sandbox obligatoire, jamais daccès aux secrets ou au code source.
**Q : Comment lancer les tests hardware ?**
A : Suis les scripts documentés dans le README et INSTALL.md.
R : Suis les scripts documentés dans le README et INSTALL.md.
**Q : Comment contribuer ?**
A : Ajoute des profils, améliore les scripts, enrichis les standards, et suis la politique anti-injection.
R : Ajoute des profils, améliore les scripts, enrichis les standards, et respecte la politique anti-injection.
**Q : Où trouver la documentation complète ?**
A : Voir [docs/index.md](docs/index.md), [RUNBOOK.md](RUNBOOK.md), [INSTALL.md](INSTALL.md).
---
R : Voir [docs/index.md](docs/index.md), [RUNBOOK.md](RUNBOOK.md), [INSTALL.md](INSTALL.md).
---
## 🦾 Workflows détaillés
### 1. Spécification → Implémentation Firmware
1. Rédige la spec dans `specs/`.
2. Ouvre une issue avec le label `ai:spec`.
3. Lagent PM/Architect génère le plan et larchitecture.
3. Lagent PM/Architecte génère le plan et larchitecture.
4. Lagent Firmware implémente le code dans `firmware/`.
5. Lagent QA ajoute des tests Unity.
6. Evidence pack généré automatiquement.
> [Spec Generator](https://webkaoss.herokuapp.com/) — science-fiction automatisée.
> [Spec Generator](https://webkaoss.herokuapp.com/) — science-fiction automatisée.
### 2. Bulk Edit Hardware KiCad
1. Ouvre une issue avec le label `ai:hw`.
2. Lagent HW effectue un bulk edit via `tools/hw/schops`.
3. Exporte ERC/DRC, BOM, netlist.
4. Snapshot avant/après dans `artifacts/hw/<timestamp>/`.
### 3. Documentation & Compliance
### 3. Documentation & Conformité
1. Ouvre une issue avec le label `ai:docs` ou `ai:qa`.
2. Lagent Doc met à jour `docs/` et le README.
3. Lagent Compliance valide le profil et génère le rapport.
> Trouve la phrase supprimée par le sanitizer, score affiché.
> _« Un evidence pack peut-il rêver de conformité ? »_
3. Lagent Conformité valide le profil et génère le rapport.
> _RtFM: Les agents QA écoutent le paysage du repo, à la recherche dun bug caché dans le souffle._
> Trouve la phrase supprimée par le sanitizer, score affiché.
> _« Un evidence pack peut-il rêver de conformité ? »_