about summary refs log tree commit homepage
path: root/HACKING
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2013-11-01 10:21:59 +0000
committerEric Wong <normalperson@yhbt.net>2013-11-01 10:38:42 +0000
commit93ba820f05aaf8c760b4a515ae996425c257a7fb (patch)
tree217cf29c5ddf2214967a35983dc8421c649feab2 /HACKING
parent9c5d5c5bf48a2996203c2e15f281575a15994694 (diff)
downloadyahns-93ba820f05aaf8c760b4a515ae996425c257a7fb.tar.gz
Hopefully it'll be easier for folks to use and contribute.
Publish it on the site while we're at it.
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING56
1 files changed, 56 insertions, 0 deletions
diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..a58c7e8
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,56 @@
+development dependencies
+------------------------
+
+* minitest RubyGem (version 4 or 5, standard in Ruby 2.0+)
+* curl - http://curl.haxx.se/ - we don't trust our own Ruby abilities :>
+* dd(1) - standard POSIX tool - to feed curl
+* GNU make - https://www.gnu.org/software/make/
+* git - http://www.git-scm.com/
+* ruby - http://www.ruby-lang.org/
+
+        git clone git://yhbt.net/yahns
+
+tests
+-----
+
+* make test - run each test in a separate process (parallelize using -j)
+* make test-mt - run tests-multithreaded in one process
+* make coverage - "make test" with coverage output
+* make coverage-mt - "make test-mt" with coverage output
+* ruby test/covshow.rb - show coverage output from previous test run
+
+For non-GNU users, GNU make may be installed as "gmake".
+
+test environment
+----------------
+
+N - specify the number of threads for *-mt targets (minitest parallelize_me!)
+RUBY - specify an alternative ruby(1) runtime
+V - set to 1 for verbose test output (may be mangled if multithreaded)
+
+documentation
+-------------
+
+We use pandoc for converting Markdown to (groff) man:
+
+* pandoc - http://johnmacfarlane.net/pandoc/
+
+installing from git
+-------------------
+
+* make install-gem (pandoc is required for generating manpages)
+
+contact
+-------
+
+We use git(7) and develop yahns on a public mailing list like git
+developers do.  Please send patches via git-send-email(1) to the public
+mailing list at <yahns-public@rubyforge.org>.  Pull requests should be
+formatted using git-request-pull(1).
+
+Mailing list archives: http://rubyforge.org/pipermail/yahns-public/
+No subscription is necessary to post to the mailing list.
+Please remember to Cc: all recipients.
+
+Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.
+License: GPLv3 or later <http://www.gnu.org/licenses/gpl-3.0.txt>