add documentation

README.rst

@@ -165,7 +165,7 @@ The ``mpsd-software-manager`` python package.
 - Install via pip or pipx.
 
   Pipx commands are:
-  
+
   - to install: ``pipx install git+https://gitlab.gwdg.de/mpsd-cs/mpsd-software-manager``
   - to update: ``pipx upgrade mpsd-software-manager``
   - to uninstall: ``pipx uninstall mpsd-software-manager``
@@ -192,7 +192,7 @@ Working example
 There is an
 `example <https://github.com/mpsd-computational-science/octopus-with-mpsd-software>`__
 compilation that shows the complete compilation cycle (including compilation of
-Octopus) using the ``foss2022a-serial`` toolchain. 
+Octopus) using the ``foss2022a-serial`` toolchain.
 
 
 
@@ -249,3 +249,6 @@ Frequently asked questions
   to experiment with toolchains etc.
 
 
+Development
+-----------
+Developers documentation is available at [development.rst](development.rst).

development.rst

+Developers Setup
+================
+This section is for developers wanting to contribute to the project.
+
+Setup pre-commit hooks
+----------------------
+The project uses [pre-commit](https://pre-commit.com/) to run some checks before committing code.
+Install pre-commit by running the following command:
+
+    pip install pre-commit
+To setup the pre-commit hooks, run the following command from the root of the project:
+
+    pre-commit install
+
+Then every time you commit, pre-commit will run all checks defined in `.pre-commit-config.yaml`.
+you can run the pre-commit checks manually by running:
+
+    pre-commit run --all-files