X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=HACKING;h=04c25172e63644cd27427854cc749698a3799591;hb=fb1f9e01c6985356058190bb8cf16b9bceb0adcc;hp=637d5dd23ce1678fc6d69d9d972ef25ac2cf3c6e;hpb=2520b2bfdb1f6cc1b5e203d8198e8ea71b483ef5;p=sup

diff --git a/HACKING b/HACKING
index 637d5dd..04c2517 100644
--- a/HACKING
+++ b/HACKING
@@ -1,4 +1,42 @@
-To run sup locally, invoke it like this:
+Running Sup from your git checkout
+----------------------------------
 
-ruby -I lib -w bin/sup
+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. You will need libruby-devel, gcc, and make installed
+to build certain gems like Ferret. Gem install does not do a good job of
+detecting when these things are missing and the build fails.
+
+Rubygems also is particularly aggressive about picking up libraries from
+installed gems. If you do have Sup installed as a gem, please examine
+backtraces to make sure you're loading files from the repository and NOT from
+the installed gem before submitting any bug reports.
+
+Coding standards
+----------------
+
+- Don't wrap code unless it really benefits from it.
+- Do wrap comments at 72 characters.
+- Old lisp-style comment differentiations:
+   # one for comments on the same line as a line of code
+   ## two for comments on their own line, except:
+   ### three for comments that demarcate large sections of code (rare)
+- Use {} for one-liner blocks and do/end for multi-line blocks.
+- I like poetry mode. Don't use parentheses unless you must.
+- The one exception to poetry mode is if-statements that have an assignment in
+  the condition. To make it clear this is not a comparison, surround the
+  condition by parentheses. E.g.:
+    if a == b                    if(a = some.computation)
+      ...             BUT          ... something with a
+    end                          end
+- and/or versus ||/&&. In Ruby, "and" and "or" bind very loosely---even
+  more loosely than function application. This makes them ideal for
+  end-of-line short-circuit control in poetry mode. So, use || and &&
+  for ordinary logical comparisons, and "and" and "or" for end-of-line
+  flow control. E.g.:
+    x = a || b or raise "neither is true"