From ba9d5106c439d63f6bb0c488ea55ab9e8116930f Mon Sep 17 00:00:00 2001
From: Nicolas <56691495+andinox@users.noreply.github.com>
Date: Tue, 15 Jul 2025 20:58:52 +0200
Subject: [PATCH] docs: add readmes for core and project

---
 DiagnosticTool/DiagnosticTool/README.md | 12 ++++++++++++
 DiagnosticTool/core/README.md           | 16 ++++++++++++++++
 2 files changed, 28 insertions(+)
 create mode 100644 DiagnosticTool/DiagnosticTool/README.md
 create mode 100644 DiagnosticTool/core/README.md

diff --git a/DiagnosticTool/DiagnosticTool/README.md b/DiagnosticTool/DiagnosticTool/README.md
new file mode 100644
index 0000000..af2778b
--- /dev/null
+++ b/DiagnosticTool/DiagnosticTool/README.md
@@ -0,0 +1,12 @@
+# Projet Django `DiagnosticTool`
+
+Ce dossier contient les fichiers principaux du projet Django. Vous y trouverez notamment le fichier `settings.py` qui regroupe toute la configuration de l'application (base de données, applications installées, paramètres de sécurité, configuration du routeur et service d'envoi de mails).
+
+## Fichiers clés
+
+- `settings.py` : paramètres de configuration du projet.
+- `urls.py` : définition des routes principales et inclusion des URLs des applications `core` et `gestionnaire_users`.
+- `asgi.py` et `wsgi.py` : points d'entrée pour servir l'application avec ASGI ou WSGI.
+- `__init__.py` : marque ce dossier comme un paquet Python.
+
+Ces fichiers définissent l'environnement et les points d'entrée de l'application web `DiagnosticTool`.
diff --git a/DiagnosticTool/core/README.md b/DiagnosticTool/core/README.md
new file mode 100644
index 0000000..ba1f666
--- /dev/null
+++ b/DiagnosticTool/core/README.md
@@ -0,0 +1,16 @@
+# Application `core`
+
+Cette application constitue le cœur fonctionnel du projet **DiagnosticTool**. Elle regroupe l'ensemble de la logique de diagnostic réseau ainsi que les modèles et vues associés.
+
+## Contenu principal
+
+- `diagnostic_scenarios/` : différents scénarios de tests réseau (perte de connexion, sécurité, tests basiques...).
+- `models/` : modèles Django représentant routeurs, interfaces, tables ARP, sessions BGP, etc.
+- `router/` : fonctions de connexion et de traitement des données récupérées sur les équipements.
+- `views/` : vues Django permettant d'afficher la page d'accueil, le tableau de bord administrateur ou encore le détail d'un scénario.
+- `scripts/` : scripts utilisés pour interagir avec les routeurs ou recevoir les données envoyées par Telegraf.
+- `management/commands/` : commandes personnalisées pour lancer des diagnostics depuis la ligne de commande.
+- `templates/` : gabarits HTML spécifiques à l'application.
+- `telegraf/` : fichiers de configuration pour la collecte d'informations via Telegraf.
+
+En centralisant ces éléments, le dossier `core` gère la récupération des données réseau, leur stockage en base et la génération des rapports affichés dans l'interface web.