From: Daniel White <daniel@whitehouse.id.au>
Date: Fri, 25 Jul 2008 16:23:53 +0000 (+1000)
Subject: Updated INSTALL with documentation of Makefile
X-Git-Tag: v0.15-rc1~175
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/stgit/commitdiff_plain/e4875f1770b77a03d19878dedfd084cf16c59574

Updated INSTALL with documentation of Makefile

Also includes information about requirements for
building and installing documentation like git's
INSTALL documentation.

Signed-off-by: Daniel White <daniel@whitehouse.id.au>
---

diff --git a/INSTALL b/INSTALL
index 8d2bebd..3da4efd 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,13 +1,18 @@
 For basic installation:
 
-	python setup.py install
+	$ make all doc ;# as yourself
+	$ make install install-doc ;# as yourself
 
 By default, the above command installs StGIT in the
 $HOME/{bin,lib,share} directories. For a different location, use the
---prefix option.
+prefix option.
 
-	python setup.py install --prefix=/usr
+	$ make prefix=/usr all doc #; as yourself
+	# make prefix=/usr install install-doc #; as root
 
-For more information:
+Issues of note:
+
+- To build and install the documentation, you need to have the
+  asciidoc/xmlto toolchain.  The default build target ("make all")
+  does _not_ build them.
 
-	http://docs.python.org/inst/inst.html