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 8d2bebd9d1824f1b7af5cfe6fbd11f9cbfde6d74..3da4efdce26a61e7af0265973183b7717afaeb80 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,13 +1,18 @@
 For basic installation:
 
 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
 
 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