From 054913ac7b499e01cecf1fa12e7b05c972081ea6 Mon Sep 17 00:00:00 2001
From: Christian Zangl <laktak@cdak.net>
Date: Fri, 22 Dec 2023 15:19:54 +0100
Subject: [PATCH] dev instructions

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index 8974f2e..24be484 100644
--- a/README.md
+++ b/README.md
@@ -195,3 +195,25 @@ error: detected 1 file with damage!
 
 `DMG` indicates damage.
 
+## Development
+
+With pipenv (install with `pipx install pipenv`):
+
+```
+# setup
+pipenv install
+
+# run chkbit
+pipenv run python3 -m cli.main
+```
+
+To build a source distribution package from pyproject.toml
+```
+pipx run build
+```
+
+You can then install your own package with
+```
+pipx install dist/chkbit-*.tar.gz
+```
+