From 93cf68d63e873ea7db0a21be73de0d666e0817cd Mon Sep 17 00:00:00 2001 From: Florian Pineau Date: Fri, 29 Aug 2025 19:10:46 +0200 Subject: [PATCH] DOCS: ajoute des informations concernant l'installation --- README.md | 47 +++++++++++++++++++++++++++++++++-------------- 1 file changed, 33 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 7d229f8..9391427 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,36 @@ Ce dossier contient un script Python pour calculer automatiquement le poids des projets en octets ainsi que le nombre de fichiers qu'ils contiennent. Ces informations correspondent aux statistiques données par Windows lorsque l'on fait clique droit > Propriété. -# Instructions +# Installation (Windows) -Pour commencer, il est nécessaire de données une liste de dossiers à parcourir. Lancer la commande suivante : - -```{bash} -.\venv\Scripts\python.exe init_args.py +- Installez git pour Windows ([lien](https://git-scm.com/downloads/win)) +- Installez Python ([lien](https://www.python.org/downloads/windows/)) +- Installez et ouvrez VSCodium ([lien](https://vscodium.com/)) +- Créez un nouveau projet en cliquant sur **File > Open Folder...** et créez un dossier **projects_stats** +- Cliquez sur **Terminal > New Terminal** +- Clonez le repository à l'aide du terminal : +```bash +git clone http://192.168.1.125:30008/Florian/projects_stats.git +``` +- Créez un environnement virtuel et activez le : +```bash +py -m venv venv +.\venv\Scripts\activate.bat +``` +- Installez les dépendances : +```bash +pip install -r .\requirements.txt ``` -Un nouveau fichier est créé : `args.json` dans le dossier courant. Ce fichier contient la structure à suivre pour y mettre la liste des dossiers projet à parcourir: +# Instructions -```{json} +Pour commencer, il est nécessaire de donner la liste de dossiers projet à parcourir. Éxecutez la commande suivante : +```bash +python init_args.py +``` + +Un nouveau fichier est créé : **args.json**. Ce fichier contient la structure à suivre pour y mettre la liste des dossiers projet à parcourir: +```json { "folder_paths": [ "path\\to\\your\\folder_1", @@ -23,16 +42,16 @@ Un nouveau fichier est créé : `args.json` dans le dossier courant. Ce fichier } ``` -Vous pouvez le remplir manuellement ou choisir une approche automatique en éxecutant la commande suivante : +Vous pouvez de remplir manuellement les champs (si vous avez peu de dossiers à parcourir) ou choisir une approche automatique en éxecutant la commande suivante : -```{bash} -.\venv\Scripts\python.exe populate_args_with_all_project_folders.py +```bash +python populate_args_with_all_project_folders.py ``` -Ensuite, lancez la commande suivante : +Enfin, éxecutez la commande suivante : -```{bash} -.\venv\Scripts\python.exe main.py +```bash +python main.py ``` -À la fin du script, un CSV `output.csv` est créé contenant la liste des projets, leur poids et leur nombre de fichiers. \ No newline at end of file +À la fin du script, un CSV **output.csv** est créé contenant la liste des projets, leur poids et leur nombre de fichiers. \ No newline at end of file