From 7f31cd5f39b2c719bf128445a64cc89e72d881be Mon Sep 17 00:00:00 2001 From: sehl Date: Fri, 24 Oct 2025 00:51:56 +0200 Subject: [PATCH] MAJ du fichier README --- README.md | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 82 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 09d0b46..1cd6aa7 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,18 @@ Bienvenue sur notre projet **"PAPILLON"**, un logiciel qui reste en permanence au premier plan, comme un papillon collé sur le moniteur. Ce projet a été réalisé dans le cadre de la [SAÉ 3.1](https://iut-fbleau.fr/sitebp/sae3/31_2025/Y8R8E4MV9Y7T33O8.php) de l'IUT Sénart-Fontainebleau. ## Table des matières -- [Introduction](#introduction) +- [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) - [Nettoyage des fichiers temporaires](#Nettoyage-des-fichiers-temporaires) -- [](#) -- [](#) -- [](#) - [Rapport d'avancement](#Rapport-davancement) - [Crédits](#crédits) --- -## Introduction +## Présentation Papillon, est une application de gestion de rappels qui permet à l'utilisateur : -D'ajouter des rappels (titre, contenu, thème, rang). @@ -21,13 +22,86 @@ Papillon, est une application de gestion de rappels qui permet à l'utilisateur -De consulter la liste de tous ses rappels. -Et d'avoir la fenêtre visible (comme un papillon posé sur l'écran). -Ce projet a été développé en **Java** en suivant les consignes de l'IUT pour . +Ce projet a été développé en **Java** en suivant les consignes de l’IUT afin d’assurer une structure claire et un code facile à maintenir. --- -## Nettoyage des fichiers temporaires +## Mise en place -Pour supprimer les fichiers temporaires (.class): +### Pré-requis +- **MariaDB client** (inclus dans le répertoire `libs`) + +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/ +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 +make compile +make run +``` + +ou + +### Création du fichier `.jar` +Vous pouvez générer une archive exécutable : +```bash +make jar +``` + +Avec l'archive .jar on exécute : +```bash +java -cp Papillon.jar:libs/mariadb fr.iutfbleau.papillon.Start +``` + + +--- + +## 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. + +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 : +```bash +make doc +``` +--- + +## Nettoyage des fichiers intermédiaires + +Pour supprimer les fichiers intermédiaires on fait : ```bash make clean ```