diff --git a/README.md b/README.md index d4f9f74..fe224a2 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,30 @@ -# Installation -Install nitpick: - pipx install nitpick +# Project configuration stuff +## Enforcing configuration + +Enforcing is done with help of nitpick - a command-line tool. + +### Installation + +Install nitpick: + +```sh +pipx install nitpick +``` + +### Usage -# Usage To check for errors only: + +```sh nitpick check +``` To fix and modify your files directly: nitpick fix + +## Initializing a project +### Python + +```sh +cookiecutter https://gitea.radium.group/radium/project-configuration.git --directory cookiecutter-python +```