update docs (#162)

* update docs

* test

* remove file

Author: twoertwein

docs/README.md

@@ -10,4 +10,4 @@ Instructions for working with the code are found here:
 
 - [How to set up the environment](setup.md)
 - [How to test the project](tests.md)
-- [Code style](style.md)
+- [How to make a release](release_procedure.md)

docs/setup.md

@@ -1,9 +1,9 @@
 ## Set Up Environment
 
-- Make sure you have `python >= 3.8` installed. </br></br>
-- Install poetry if you still don't have: </br> `pip install poetry`</br> </br>
-- Install the project dependencies with: </br> `poetry update -vvv` </br></br>
-- Enter the virtual environment: </br> `poetry shell`</br></br>
-- Run all tests to make sure the project is ok: </br> `poe test_all` </br></br>
-- Enable pre-commit:  </br> `pre-commit install` </br></br>
-- Do you want to add a new dependency? </br> `poetry add --dev foo-pkg ` </br></br>
+- Make sure you have `python >= 3.8` installed.
+- Install poetry: `pip install poetry`
+- Install the project dependencies: `poetry update`
+- Enter the virtual environment: `poetry shell`
+- Run all tests: `poe test_all`
+- Enable pre-commit:  `pre-commit install`
+- Do you want to add a new dependency? `poetry add --dev foo-pkg`

docs/style.md

@@ -1,15 +1,15 @@
 ## Test
 
-- Run all local tests against source code. </br> `poe test` </br> </br> 
-  - Profiles: </br>
-    - Default: Runs only mypy and pyright tests </br> `poe test --profile=default` </br>
-    - Pytest: Runs only pytest </br> `poe test --profile=pytest` </br> 
-    - Pre-commit: Runs all style checks in pre-commit </br> `poe test --profile=style` </br> 
+[Poe](https://github.com/nat-n/poethepoet) is used to run all tests.
 
-- Run local tests against an installed distribution: </br> `poe test_dist` </br> </br>
+Here are the most important options. Fore more details, please use `poe --help`.
 
-- Run all local tests (against both source and installed distribution) : </br> `poe test_all` </br> </br>
+- Run all tests (against both source and installed stubs): `poe test_all`
+- Run tests against the source code: `poe test` 
+  - Run only mypy: `poe mypy`
+  - Run only pyright: `poe pyright`
+  - Run only pytest: `poe pytest`
+  - Run only pre-commit: `poe style`
+- Run tests against the installed stubs (this will install and uninstall the stubs): `poe test_dist`
 
-- Forgot some command? </br>`poe --help` </br> </br>
-
-- These tests originally came from https://github.com/VirtusLab/pandas-stubs.
+These tests originally came from https://github.com/VirtusLab/pandas-stubs.