about summary refs log tree commit homepage
path: root/HACKING
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2012-01-11 21:46:04 +0000
committerEric Wong <normalperson@yhbt.net>2012-01-11 21:46:04 +0000
commit301b41b6f1350806a750794d615e3468735757a6 (patch)
tree54deb2b4cb0060a54746e3635746d0f338c294f5 /HACKING
downloadcmogstored-301b41b6f1350806a750794d615e3468735757a6.tar.gz
Nuked old history since it was missing copyright/GPLv3 notices.
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING25
1 files changed, 25 insertions, 0 deletions
diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..dad1c83
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,25 @@
+Bootstrapping from the git repo requires GNU autotools, Gnulib and
+Ragel.  You will need "autoreconf", "gnulib-tool" and "ragel" in your
+$PATH.  Some of the tests require "ruby" (any 1.8 or later version will
+do).
+
+* autoconf - https://www.gnu.org/software/autoconf/
+* automake - https://www.gnu.org/software/automake/
+* Gnulib - https://www.gnu.org/software/gnulib/
+* Ragel - http://www.comp-lang.org/ragel/ (parser)
+* ruby - http://www.ruby-lang.org/
+* git - http://www.git-scm.com/
+
+$ git clone git://bogomips.org/cmogstored
+$ cd cmogstored && ./autogen.sh
+
+Generally, the versions of these tools bundled with the latest
+stable release of Debian GNU/Linux will work.
+
+For Gnulib, we will use the latest git checkouts from:
+        git://git.savannah.gnu.org/gnulib.git
+
+Hack away!
+
+Email patches (git format-patch + git send-email) and pull requests to
+Eric Wong <normalperson@yhbt.net>