diff --git a/README.md b/README.md index dee67d9..3e3e740 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,32 @@ # Dungeon Battle M1 Software engineering project + +## Création d'un environnement de développement + +Il est toujours préférable de travailler dans un environnement Python isolé du reste de son instalation. + +1. **Installation des dépendances de la distribution.** + Vous devez déjà installer Python et le module qui permet de créer des environnements virtuels. + On donne ci-dessous l'exemple pour une distribution basée sur Debian, mais vous pouvez facilement adapter pour ArchLinux ou autre. + + ```bash + $ sudo apt update + $ sudo apt install --no-install-recommends -y python3-setuptools python3-venv python3-dev git + ``` + +2. **Clonage du dépot** là où vous voulez : + + ```bash + $ git clone git@gitlab.crans.org:ynerant/dungeon-battle.git && cd dungeon-battle + ``` + +3. **Création d'un environment de travail Python décorrélé du système.** + On n'utilise pas `--system-site-packages` ici pour ne pas avoir des clashs de versions de modules avec le système. + + ```bash + $ python3 -m venv env + $ source env/bin/activate # entrer dans l'environnement + (env)$ pip3 install -r requirements.txt + (env)$ deactivate # sortir de l'environnement + ```