add: readme

This commit is contained in:
starnakin 2023-11-03 22:25:27 +01:00
parent e1d102a9c6
commit 519a405baf

23
README.md Normal file
View File

@ -0,0 +1,23 @@
# Python lib
A python lib to interract with the api more easly
## Installation
- Clone the project:
``` bash
git clone https://git.chauvet.pro/michel/ft_transcendence
cd ft_transcendence
git switch python-api
```
- Create python virtual environnement.
``` bash
python3 -m venv .env
```
- Source the environnement.
``` bash
source .env/bin/activate
```
- Install the requirements
``` bash
pip install -r requirements.txt
```