README
17 lines
| 609 B
| text/plain
|
TextLexer
/ doc / README
Martin Geisler
|
r9172 | Mercurial's documentation is kept in reStructuredText format, which is | ||
a simple plain text format that's easy to read and edit: | ||||
jake@edge2.net
|
r177 | |||
Martin Geisler
|
r9172 | http://docutils.sourceforge.net/rst.html | ||
jake@edge2.net
|
r177 | |||
Martin Geisler
|
r9172 | It's also convertible to a variety of other formats including standard | ||
UNIX man page format and HTML. | ||||
jake@edge2.net
|
r177 | |||
Martin Geisler
|
r9172 | To do this, you'll need to install the rst2html and rst2man tools, | ||
which are part of Docutils: | ||||
jake@edge2.net
|
r177 | |||
Martin Geisler
|
r9172 | http://docutils.sourceforge.net/ | ||
jake@edge2.net
|
r177 | |||
Martin Geisler
|
r9172 | The rst2man tool is still in their so-called "sandbox". The above page | ||
has links to tarballs of both Docutils and their sandbox. | ||||
jake@edge2.net
|
r177 | |||
Martin Geisler
|
r9172 | Use the Makefile in this directory to generate the man and HTML pages. | ||