diff --git a/README.md b/README.md index db2aad9a0d653a2d151166348f59e6d34c97aa65..8b54f8407b3f17d9a15e16c445e037bc0811c3f2 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,15 @@ This is the repo to store all the EasyBuild configuration files, including easyconfigs. Each stage is in a separate branch, containing all the relevant files for that stage + + +This repository uses [autopep8](https://github.com/hhatto/autopep8) and [pre-commit](https://pre-commit.com). For that, you need to run this on your machine: + +```sh +pip3 install --user autopep8 +pip3 install --user pre-commit +pre-commit install +``` + +After those steps, `pre-commit` will call `autopep8` on each commit, and make small changes pass the pep8 test without needing to do a manual `eb --check-style` and checking each little mistake. +