Add: instructions for building, using .deb to README

1 files changed, 31 insertions, 0 deletions

diff --git a/README b/README
index 68511f9..5fba99c 100644
--- a/README
+++ b/README
@@ -55,6 +55,37 @@ To actually run builds, you need to run `worker-manager`:
 The substitute the correct URL for the controller.
 
 
+Using the .deb package
+-----------------------------------------------------------------------------
+
+To build the .deb package (you may have to fix the version number):
+
+    git archive HEAD | xz > ../ick2_0.2.1+git.orig.tar.xz
+    debuild -us -uc
+    sudo debi
+
+After this, you'll want to create `/etc/ick2/projects.yaml`, for
+example:
+
+    projects:
+      count:
+        shell_steps: 
+        - for x in $(seq 100); do echo hello, $x; sleep 1; done
+    
+Also, you'll want to enable and start the ick2 service:
+
+    sudo systemctl enable ick2
+    sudo systemctl start ick2
+
+After this:
+
+    curl http://localhost:12765/projects
+    curl http://localhost:12765/projects/count/+trigger
+    ./worker-manager http://localhost:12765
+
+Good luck!
+
+
 Legalese
 -----------------------------------------------------------------------------