Rework documentation

[ChrisRBe]

Current documentation is not user friendly:

• missing proper guidelines to set up a development environment
• how to use
• how to contribute

[AlexanderLill]

Just from my little experience from my last MR:

1. Install pipenv (example for OSX with brew: brew install pipenv)
2. Install dependencies for this project with pipenv install
3. Start a shell that can use all dependencies: pipenv shell
4. Run all tests: pytest -v --doctest-modules
5. Automatically format code: black ./src

[flod1]

is there also a guide or executable windows version

[ChrisRBe]

Hi @flod1,

there's currently no executable version available.

You should be able to follow the setup also under Windows:

1. Download and install Python 3.8 or later (Download from python.org) (unit tests are executed against 3.8 to 3.11)
2. Open a terminal/cmd and run pip install pipenv
3. once pipenv is installed navigate to the downloaded (either unpacked archive or via git clone) directory
4. Install all dependencies via pipenv install (if you also need the dev packages add the --dev parameter)
5. Enter the virtual env pipenv shell
6. run the script