diff --git a/README.md b/README.md index eea710d..e017fde 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ ![Python v3.10.8](https://img.shields.io/badge/python-v3.10.8-blue "Python v3.10.8") ![License LGPLv3](https://img.shields.io/badge/license-LGPLv3-blue "License LGPLv3") +![Tests 8 passed](https://img.shields.io/badge/tests-40%20passed-green "Tests 8 passed") - -GestForm is a FizzBuzz like challenge 😁 +GestForm is a FizzBuzz like challenge. In this test we need to : - From a random (not pseudo random ?) list of number between -1000 to 1000 @@ -16,3 +16,35 @@ In this test we need to : - else display the number All files must be provided to be checked. + +## How use it (Debian/Ubuntu) + +Create a venv +``` +python3 -m venv gestform +cd gestform +git clone https://gitlab.com/valbou2/GestForm +source bin/activate +cd GestForm +python gestform.py +``` + +## How to test it (Debian/Ubuntu) + +Run tests from GestForm folder +``` +source ../bin/activate +python -m unittest tests +``` + +## Information + +You can use requirements to show indent and PEP8 issues: +``` +source ../bin/activate +pip install -r requirements.txt +python -m black ./ +python -m flake8 ./ +``` + +The project don't have dependencies to run.