From fe913a0edccfed112564a7e00a059c59d195a0a8 Mon Sep 17 00:00:00 2001 From: Zayd NAHLI Date: Wed, 22 Jan 2025 21:43:02 +0100 Subject: [PATCH 1/3] Initial commit --- LICENSE | 9 +++++++++ README.md | 2 ++ 2 files changed, 11 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2071b23 --- /dev/null +++ b/LICENSE @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..82d79ff --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# CodeMap + From 921ea58f68e45564f3bc7ed7d40f68d18b536552 Mon Sep 17 00:00:00 2001 From: Zayd NAHLI Date: Wed, 22 Jan 2025 21:46:39 +0100 Subject: [PATCH 2/3] =?UTF-8?q?Mise=20=C3=A0=20jour=20de=20'README.md'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 50 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 82d79ff..559ca42 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,51 @@ -# CodeMap +# CodeMap : Générateur de Diagrammes de Classes PlantUML et Documentation +**CodeMap** est un outil simple qui vous permet de générer rapidement des diagrammes de classes UML ainsi que de la "documentation" pour vos projets en Java et C#. En quelques clics, vous pouvez visualiser la structure de votre code et générer toute la documentation nécessaire, le tout avec une interface intuitive. + +## Fonctionnalités principales + +- **Prise en charge des projets Java et C#** : Que vous travailliez sur un projet en Java ou en C#, CodeMap s'adapte pour en extraire les diagrammes UML avec précision. +- **Interface conviviale** : Choisissez simplement le chemin de votre projet, sélectionnez votre langage (Java ou C#), et indiquez si vous souhaitez générer des diagrammes UML, de la "documentation", ou les deux. +- **Génération rapide et simple** : En quelques clics, vous obtenez votre diagrammes et votre documentation. +- **Précision et clarté** : Les diagrammes générés sont directement basés sur votre code, assurant une représentation fidèle et claire. + +## Installation +1. Clonez le dépôt du projet : + ```bash + git clone + ``` +2. Installez les dépendances requises : + ```bash + pip install -r requirements.txt + ``` + +## Utilisation +1. Exécutez le script principal : + ```bash + python main.py + ``` +2. Une interface s'ouvrira vous permettant de : + - Sélectionner le chemin de votre projet à l'aide de l'explorateur de fichiers. + - Indiquer si le projet est en Java ou C#. + - Choisir le type de génération souhaité : diagrammes UML, documentation, ou les deux. +3. Cliquez sur **Générer** pour obtenir les résultats, le répertoire de sortie s'ouvrira automatiquement. + +## Tâches en cours et futures +Voici une liste des fonctionnalités déjà en place et des améliorations prévues : + +### Fonctionnalités déjà implémentées +- [x] Génération de diagrammes de classes UML pour les projets Java et C#. +- [x] Interface utilisateur intuitive avec explorateur de fichiers intégré. + +### Améliorations prévues +- [ ] Support pour d'autres langages (Python, JavaScript, etc.). +- [ ] Génération automatique de README pour les projets analysés. +- [ ] Amélioration de l'interface utilisateur (apparence et ergonomie). +- [ ] Optimisation des performances pour une génération plus rapide. +- [ ] Ajout d'options de personnalisation pour les diagrammes générés. + +## Contributions +Pour contribuer, corriger des bugs ou proposer des fonctionnalités, soumettez un pr. + +## Licence +Ce projet est sous licence MIT. Vous êtes libre de l'utiliser, de le modifier et de le partager. \ No newline at end of file From 82ef34133d0520bcaefff41d6ee4846387986019 Mon Sep 17 00:00:00 2001 From: Zayd NAHLI Date: Wed, 22 Jan 2025 21:46:57 +0100 Subject: [PATCH 3/3] =?UTF-8?q?Mise=20=C3=A0=20jour=20de=20'README.md'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 559ca42..a4d6695 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ ## Installation 1. Clonez le dépôt du projet : ```bash - git clone + git clone https://codefirst.iut.uca.fr/git/zayd.nahli/CodeMap.git ``` 2. Installez les dépendances requises : ```bash