]> git.cworth.org Git - sup/blobdiff - HACKING
fix (mostly!) the updates system
[sup] / HACKING
diff --git a/HACKING b/HACKING
index 637d5dd23ce1678fc6d69d9d972ef25ac2cf3c6e..8a3dae60356f015ffcd404b788305d41108ee488 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -1,4 +1,20 @@
-To run sup locally, invoke it like this:
+Running Sup locally
+-------------------
+Invoke it like this:
 
 ruby -I lib -w bin/sup
 
+You'll have to install all gems mentioned in the Rakefile (look for the line
+setting p.extra_deps). If you're on a Debian or Debian-based system (e.g.
+Ubuntu), you'll have to make sure you have a complete Ruby installation,
+especially libssl-ruby.
+
+Coding standards
+----------------
+
+- Don't wrap code unless it really benefits from it. The days of
+  80-column displays are long over. But do wrap comments and other
+  text at whatever Emacs meta-Q does.
+- I like poetry mode.
+- Use {} for one-liner blocks and do/end for multi-line blocks.
+