From 99c5720489f91dc9eb98c6531c2b21e6ef13b041 Mon Sep 17 00:00:00 2001
From: Christopher Baines <mail@cbaines.net>
Date: Wed, 12 Jul 2023 11:59:02 +0100
Subject: Add some local development instructions

---
 README.org | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

(limited to 'README.org')

diff --git a/README.org b/README.org
index 0347bb6..6363e8d 100644
--- a/README.org
+++ b/README.org
@@ -4,6 +4,31 @@ This service is intended to assist with quality assurance within
 Guix. That is maintaining and improving the quality of many aspects of
 Guix, like packages for example.
 
+* Local Development
+
+Use the guix-dev.scm file to provide the dependencies.
+
+#+BEGIN_SRC shell
+guix environment -l guix-dev.scm
+#+END_SRC
+
+Then run the following commands:
+
+#+BEGIN_SRC shell
+./bootstrap.sh
+./configure
+make
+#+END_SRC
+
+After that, you can start the service via:
+
+#+BEGIN_SRC shell
+./pre-inst-env scripts/guix-qa-frontpage
+#+END_SRC
+
+Expect pages to load slowly since the QA frontpage won't have up to date
+cached data to use.
+
 * Ideas
 ** General functionality
 
-- 
cgit v1.2.3