From 94c9a4e7c9c605bb438a1f2c0f5e71ebf3197bfc Mon Sep 17 00:00:00 2001 From: Anton Kasimov Date: Sat, 9 Dec 2023 03:30:29 +0300 Subject: [PATCH] =?UTF-8?q?=D0=98=D0=BD=D1=81=D1=82=D1=80=D1=83=D0=BA?= =?UTF-8?q?=D1=86=D0=B8=D0=B8=20=D0=BF=D0=BE=20=D0=B7=D0=B0=D0=BF=D1=83?= =?UTF-8?q?=D1=81=D0=BA=D1=83=20cookiecutter?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 28 ++++++++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) 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 +```