From 93ba820f05aaf8c760b4a515ae996425c257a7fb Mon Sep 17 00:00:00 2001
From: Eric Wong <normalperson@yhbt.net>
Date: Fri, 1 Nov 2013 10:21:59 +0000
Subject: doc: add HACKING/INSTALL docs + minitest dependency

Hopefully it'll be easier for folks to use and contribute.
Publish it on the site while we're at it.
---
 HACKING       | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 INSTALL       |  8 ++++++++
 Rakefile      |  4 ++--
 yahns.gemspec |  3 +++
 4 files changed, 69 insertions(+), 2 deletions(-)
 create mode 100644 HACKING
 create mode 100644 INSTALL

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>
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..bd269f2
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,8 @@
+yahns is available as a RubyGem from RubyGems.org
+
+	gem install yahns
+
+No tarballs are currently provided.
+
+You may also install yahns from the git source, see the HACKING document for
+more details.
diff --git a/Rakefile b/Rakefile
index 5d36835..708a0f1 100644
--- a/Rakefile
+++ b/Rakefile
@@ -35,13 +35,13 @@ end
 
 task rsync_docs: "NEWS" do
   dest = ENV["RSYNC_DEST"] || "yahns.yhbt.net:/srv/yahns/"
-  top = %w(NEWS README COPYING)
+  top = %w(INSTALL HACKING NEWS README COPYING)
   files = []
 
   # git-set-file-times is distributed with rsync,
   # Also available at: http://yhbt.net/git-set-file-times
   # on Debian systems: /usr/share/doc/rsync/scripts/git-set-file-times.gz
-  sh("git", "set-file-times", "examples", *top)
+  sh("git", "set-file-times", "Documentation", "examples", *top)
 
   `git ls-files Documentation/*.txt`.split(/\n/).concat(top).each do |txt|
     gz = "#{txt}.gz"
diff --git a/yahns.gemspec b/yahns.gemspec
index 20caa4d..e9de2f6 100644
--- a/yahns.gemspec
+++ b/yahns.gemspec
@@ -14,6 +14,9 @@ Gem::Specification.new do |s|
   s.add_dependency(%q<sleepy_penguin>, '~> 3.2')
   s.add_dependency(%q<sendfile>, '~> 1.2.1')
   s.add_dependency(%q<unicorn>, '~> 4.6.3')
+
+  # minitest is standard in Ruby 2.0
+  s.add_development_dependency(%q<minitest>, '~> 4.3', '~> 5.0')
   s.homepage = "http://yahns.yhbt.net/README"
   s.licenses = "GPLv3+"
 end
-- 
cgit v1.2.3-24-ge0c7