Add hacking instructions.

1 files changed, 31 insertions, 0 deletions

diff --git a/HACKING.md b/HACKING.md
new file mode 100644
index 0000000..d2cf884
--- /dev/null
+++ b/HACKING.md
@@ -0,0 +1,31 @@
+# Drop into a development environment
+
+The easiest way to get all the dependencies and development tools is to use `guix shell`.
+```
+guix shell -L .guix -m manifest.scm
+```
+
+# Build the C source code
+
+Initialize the meson build directory.
+```
+meson setup builddir
+```
+Compile the C source code. Repeat this command everytime you modify the C code.
+```
+meson compile -C builddir
+```
+
+# Run domagi
+
+Run domagi like so:
+```
+./pre-inst-env python3 -m domagi.domagi <subcommand> ...
+```
+
+# Run tests
+
+Run tests.
+```
+./pre-inst-env python3 -m pytest
+```