INSTALL: explain how to build documentation
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
Jun 18, 2007 at 01:43 UTC
a90918e8244d98862d0183de949fe9764c40e4d5
1 file changed
+10
-4
INSTALL
+10
-4
@@ -89,10 +89,16 @@ Issues of note:
89
will include them. Note that config.mak is not distributed;
90
the name is reserved for local settings.
91
92
- - To build and install documentation suite, you need to have the
93
- asciidoc/xmlto toolchain. Alternatively, pre-formatted
94
- documentation are available in "html" and "man" branches of the git
95
- repository itself. For example, you could:
92
+ - To build and install documentation suite, you need to have
93
+ the asciidoc/xmlto toolchain. Because not many people are
94
+ inclined to install the tools, the default build target
95
+ ("make all") does _not_ build them. The documentation is
96
+ written for AsciiDoc 7, but "make ASCIIDOC8=YesPlease doc"
97
+ will let you format with AsciiDoc 8.
98
+
99
+ Alternatively, pre-formatted documentation are available in
100
+ "html" and "man" branches of the git repository itself. For
101
+ example, you could:
102
103
$ mkdir manual && cd manual
104
$ git init