Commit db38eb51 authored by Bas Nijholt's avatar Bas Nijholt

add pre-commit to the README

parent cc48f017
......@@ -54,7 +54,6 @@ Optionally, install Scipy 1.2 to benefit from ``rotation`` functionality.
pip install scipy==1.2
# Building from sources
As this package is pure python standard python installation from sources with
......@@ -77,6 +76,15 @@ To install version that has been already used in research project use
pip install git+https://gitlab.kwant-project.org/semicon/semicon.git@v0.2.0
```
# Development
We use [`pre-commit`](https://pre-commit.com) to keep a consistent code style, so ``pip install pre_commit`` and run
```bash
pre-commit install
```
to install the hooks.
These will then automatically run upon each commit.
# Tips about developing inside docker container
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment