Initial commit: MUD client v0.2

docs/README.md

@@ -0,0 +1,41 @@
+# `docs/` — indice della documentazione di `progetto2`
+
+Documentazione completa del client MUD CLI. La lingua è l'italiano per
+coerenza con il `README.md` principale. I blocchi di codice e i nomi
+di simboli rimangono in inglese.
+
+| Sezione | Cosa trovi |
+| --- | --- |
+| [`architecture.md`](./architecture.md) | Analisi architetturale: dipendenze tra moduli, data flow, boundary, accoppiamenti noti. **Leggi prima questo.** |
+| [`modules.md`](./modules.md) | Descrizione modulo‑per‑modulo: scopo, API pubblica, dipendenze interne, slot/responsabilità. |
+| [`protocol.md`](./protocol.md) | Telnet (IAC state machine), GMCP wire format, euristiche Dead Souls, ANSI handling. |
+| [`usage.md`](./usage.md) | Tutti i flag della CLI + esempi + flusso di auto‑login + comandi locali `/...`. |
+| [`events.md`](./events.md) | Schema completo degli eventi emessi dal `EventLogger` (JSONL + Markdown). |
+| [`development.md`](./development.md) | Setup dev, `pytest`, `ruff`, come aggiungere un modulo, debugging. |
+| [`gitea.md`](./gitea.md) | Flusso di pubblicazione sul server Gitea `192.168.0.183:8085` (utente `truetype`) + **regole di sicurezza del token**. |
+
+## Biglietto da visita
+
+```
+        ┌──────────────┐
+        │   cli.py     │   ← orchestratore async (prompt / dispatcher)
+        └──────┬───────┘
+               │
+   ┌───────────┼─────────────┐
+   │           │             │
+┌─▼────┐  ┌────▼─────┐  ┌─────▼──────┐
+│logger│  │  telnet  │  │   mapper   │
+└──────┘  └─────┬────┘  └─────┬──────┘
+                 │             │
+                 │ GMCP        ▲ via deadsouls (testo)
+        ┌────────▼────────┐    │
+        │     gmcp        │    │
+        └─────────────────┘    │
+                               │
+                       ┌───────▼────────┐
+                       │   deadsouls    │
+                       └────────────────┘
+                       + ansi (foglia pura)
+```
+
+Per la versione completa e discorsa vedi [`architecture.md`](./architecture.md).