* HACKING: Add a file for people who wish to hack on live-f1.

* Makefile.am: Ship the HACKING file.

ChangeLog

@@ -1,5 +1,8 @@
 2006-03-16  Scott James Remnant  <scott@netsplit.com>
 
+	* HACKING: Add a file for people who wish to hack on live-f1.
+	* Makefile.am: Ship the HACKING file.
+
 	* README: Write a new proper README that gives the dependencies and
 	usage information.
 

HACKING

@@ -0,0 +1,80 @@
+The live-f1 source tree is available using Bazaar-NG with the
+following URL, if you plan to hack on live-f1 please work off this
+branch.
+
+	http://www.netsplit.com/bzr/live-f1/
+
+Releases are available from the FTP site:
+
+	ftp://ftp.netsplit.com/pub/live-f1/
+
+live-f1 uses the Malone bug tracking system:
+
+	http://launchpad.net/products/live-f1/+bugs
+
+If you want to contribute code or bug fixes, please either provide the
+URL to your own Bazaar-NG branch or use the ‘unified’ diff format
+(diff -pu) and attach the patch to a bug.  Please supply a suggested
+ChangeLog entry with your patch.
+
+
+Maintainer tools
+----------------
+
+The source tree for live-f1 uses the GNU Build System (sometimes known
+as the GNU Autotools).  You will need the following versions
+installed.
+
+	* GNU Autoconf 2.59
+	* GNU Automake 1.9
+	* GNU Gettext 0.14.5
+
+After checking our live-f1 from Bazaar-NG you will need to use these
+tools to generate the build files.  The correct way to do this is to
+simply run ‘autoreconf -i’ from the top-level source directory.
+
+
+Configure options
+-----------------
+
+There are some configure script options that you may find useful when
+hacking on live-f1.
+
+	* --enable-compiler-warnings: (GCC only) adds extra CFLAGS to
+	increase the source checking and treat all warnings as errors.
+
+	* --disable-compiler-optimisations: ensures that no compiler
+	optimisations are performed during compilation, easing
+	debugging.
+
+	* --disable-linker-optimisations: disables the usual linker
+	optimisations, slightly decreasing build time.
+
+	* --enable-compiler-coverage: (GCC only) enables coverage file
+	generation, useful for test suites.
+
+
+Coding style
+------------
+
+The coding style for live-f1 is roughly K&R with function names in
+column 0, and variable names aligned in declarations.
+
+The right results can be almost acheived by doing the following.
+
+	* GNU Emacs: if you're not using auto-newline, the following
+	should do the right thing:
+
+	(defun live-f1-c-mode-common-hook ()
+	  (c-set-style "k&r")
+	  (setq indent-tabs-mode t
+	        c-basic-offset 8))
+
+	* VIM: the default works except for the case labels in switch
+	statements.  Set the following option to fix that:
+
+	setlocal cinoptions=:0
+
+	* Indent: can be used to reformat code in a different style:
+
+	indent -kr -i8 -psl

Makefile.am

@@ -2,4 +2,6 @@
 
 SUBDIRS = po intl src
 
+EXTRA_DIST = HACKING
+
 ACLOCAL_AMFLAGS = -I m4