X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=HACKING;h=8a3dae60356f015ffcd404b788305d41108ee488;hb=c72afce21deb1c3c46000cf166df7d5149d60650;hp=47c072d14ba1c3a447c000345210b32c4e9ed6b6;hpb=cf5d8d40915f6242c4b96e0bb6a7847c8a243ebc;p=sup diff --git a/HACKING b/HACKING index 47c072d..8a3dae6 100644 --- a/HACKING +++ b/HACKING @@ -4,16 +4,17 @@ 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 ---------------- -- Wrap code at 99999 characters. The days of 80-column displays are - long over. Wrap comments and other text at whatever Emacs meta-Q - does. -- Use as few parentheses as possible. +- 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. -- For one-line functions, put a semicolon before "end", like this: - def bool_writer *args; attr_writer(*args); end - (I just started doing this for no real reason, and now I kinda like - it.)