📝 docs(README.md): add installation instructions for Windows, Linux, and Mac

 feat(README.md): add automated installation scripts for Windows, Linux, and Mac
The README file now includes instructions for both manual and automated installation of the program. Automated installation scripts have been added for Windows, Linux, and Mac to simplify the installation process. The scripts install the required dependencies using pip.
This commit is contained in:
Djalim Simaila 2023-05-22 15:25:07 +02:00
parent 16a316eed5
commit 3b809b3881
9 changed files with 25 additions and 1 deletions

View File

@ -35,6 +35,18 @@ L'outil permet également l'affichage de plusieurs graphiques, tels que :
Veuillez noter que ce programme nécessite une version de Python 3.10 ou supérieure.
### Installation automatisée
Le dépôt contient des scripts qui facilitent l'utilisation du programme. Cependant, ces scripts supposent que Python 3 est installé et accessible dans le PATH.
Utilisateurs Windows : Exécutez `install_deps.bat` pour installer les dépendances. Cette étape n'est nécessaire qu'une seule fois. Ensuite, exécutez `launch.bat` pour lancer le programme.
Utilisateurs Linux/Mac : Exécutez `install_deps.sh` pour installer les dépendances. Cette étape n'est nécessaire qu'une seule fois. Ensuite, exécutez `launch.sh` pour lancer le programme.
Utilisateurs Mac : Exécutez `install_deps.command` pour installer les dépendances. Cette étape n'est nécessaire qu'une seule fois. Ensuite, exécutez `launch.command` pour lancer le programme.
### Installation manuelle
Pour utiliser le programme, vous pouvez le cloner à partir du dépôt Git ou télécharger l'une des [versions disponibles](https://forgemia.inra.fr/scanner3d/analysemorphologique/-/releases) et installer les dépendances à l'aide de pip.
```bash

1
install_deps.bat Executable file
View File

@ -0,0 +1 @@
pip install -r requirements.txt

2
install_deps.command Executable file
View File

@ -0,0 +1,2 @@
#!/bin/bash
python3 -m pip install -r requirements.txt

2
install_deps.sh Executable file
View File

@ -0,0 +1,2 @@
#!/bin/bash
python3 -m pip install -r requirements.txt

1
launch.bat Executable file
View File

@ -0,0 +1 @@
main.py

2
launch.command Executable file
View File

@ -0,0 +1,2 @@
#/bin/bash
python3 main.py

2
launch.sh Executable file
View File

@ -0,0 +1,2 @@
#/bin/bash
python3 main.py

View File

@ -1,3 +1,4 @@
#!/usr/bin/env python3
"""
Created on Fri Apr 21 2023
@name: app.py

View File

@ -1,4 +1,5 @@
vispy==0.12.2
PyQt5==5.15.9
numpy==1.24.2
PyYAML==6.0
PyYAML==6.0
matplotlib==3.7.1