From f87db2daff5cf0cde0a545bb8ac7ed0d7b051c92 Mon Sep 17 00:00:00 2001 From: Arun Isaac Date: Mon, 27 Jul 2026 23:31:38 +0100 Subject: Add hacking instructions. --- HACKING.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 HACKING.md 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 ... +``` + +# Run tests + +Run tests. +``` +./pre-inst-env python3 -m pytest +``` -- cgit 1.4.1