Derniere version du README.md et du MAKEFILE

2025-10-26 04:53:21 +01:00
parent f05e5375de
commit 56151b0a47
3 changed files with 57 additions and 42 deletions
@@ -4,7 +4,6 @@ Bienvenue sur notre projet **"PAPILLON"**, un logiciel qui reste en permanence a

 ## Table des matières
 - [Présentation](#présentation)
- [Mise en place](#mise-en-place)
 - [Organisation du projet](#organisation-du-projet)
 - [Compilation et lancement](#Compilation-et-lancement)
 - [Création de la documentation](#création-de-la-documentation)
@@ -26,7 +25,49 @@ Ce projet a été développé en **Java** en suivant les consignes de l’IUT af

 ---

-## Mise en place
+## Organisation du projet
+
+L’organisation du projet suit une structure claire permettant de séparer le code source, les composants externes et les fichiers de configuration.Voici l'aborescence :
+
+```
+SAE31_2025/
+├── Documentations/
+│   ├── Diagrammes/
+│   └── Rapports.pdf
+├── lib/ # Bibliothèques externes MariaDB
+├── src/ # Code source du projet
+│ └── fr/iutbleau/papillon/ # Package principal contenant toutes les classes Java
+│       ├── BaseDeDonnees.java
+│       ├── BtnAjouter.java
+│       ├── BtnModifier.java
+│       ├── BtnSupprimer.java
+│       ├── ChoixRang.java
+│       ├── ColorIcon.java
+│       ├── CouleurList.java
+│       ├── Crud.java
+│       ├── FenetreAjout.java
+│       ├── FenetreModif.java
+│       ├── FenetreRappel.java
+│       ├── GestionAjout.java
+│       ├── GestionModif.java
+│       ├── GestionRappel.java
+│       ├── LimiteContenu.java
+│       ├── Main.java
+│       ├── PanelRappel.java
+│       ├── Rappel.java
+│       ├── RappelBD.java
+│       ├── Start.java
+│       ├── UserKey.java
+│       ├── Utilisateur.java
+│       └── UtilisateurBD.java
+├── .gitignore # Permet d’ignorer les fichiers .class générés lors de la compilation
+├── Makefile # Automatisation pour la compilation et l’exécution
+├── README.md # Fichier actuelle
+└── logo.png #Logo de la fenêtre
+```
+---
+
+## Compilation et lancement

 ### Pré-requis
 - **MariaDB client** (inclus dans le répertoire `libs`)
@@ -34,6 +75,7 @@ Ce projet a été développé en **Java** en suivant les consignes de l’IUT af
 ---

 Pour avoir accès au projet faire les commandes suivantes:
+
 ```bash
 # Cloner le dépôt
 git clone https://grond.iut-fbleau.fr/yolou/SAE31_2025/
@@ -41,7 +83,7 @@ cd SAE31_2025
 ```
 Pour compile et exécuter
 ```bash
-# Compiler le projet et exécuter le fichier .JAR dans tous les répertoires de test
+# Compiler et exécuter le projet
 make compile
 make run
 ```
@@ -56,44 +98,12 @@ make jar

 Avec l'archive .jar on exécute :
 ```bash
-java -cp Papillon.jar:libs/mariadb fr.iutfbleau.papillon.Start
+make run-jar
 ```


 ---

-## Organisation du projet
-
-L’organisation du projet suit une structure claire permettant de séparer le code source, les composants externes et les fichiers de configuration.Voici l'aborescence :
-
-```
-SAE31_2025/
-├── lib/ # Bibliothèques externes MariaDB
-├── src/ # Code source du projet
-│ └── fr/iutbleau/papillon/ # Package principal contenant toutes les classes Java
-│       ├── BaseDeDonnees.java
-│       ├── BtnAjouter.java
-│       ├── BtnModifier.java
-│       ├── BtnSupprimer.java
-│       ├── ColorIcon.java
-│       ├── CouleurList.java
-│       ├── Crud.java
-│       ├── FenetreAjout.java
-│       ├── FenetreModif.java
-│       ├── GestionAjout.java
-│       ├── GestionModif.java
-│       ├── GestionRappel.java
-│       ├── Main.java
-│       ├── PanelRappel.java
-│       ├── Rappel.java
-│       └── Start.java
-├── .gitignore # Permet d’ignorer les fichiers .class générés lors de la compilation
-├── Makefile # Automatisation pour la compilation et l’exécution
-├── papillon.sql # Script SQL pour la base de données du projet
-└── README.md # Fichier actuelle
-```
---
-
 ## Création de la documentation

 La documentation du code source est générée via **Javadoc**. Utilisez :