sapling/doc/README

20 lines
676 B
Plaintext
Raw Normal View History

Mercurial's documentation is kept in reStructuredText format, which is
a simple plain text format that's easy to read and edit:
2005-05-27 18:16:58 +04:00
http://docutils.sourceforge.net/rst.html
2005-05-27 18:16:58 +04:00
It's also convertible to a variety of other formats including standard
UNIX man page format and HTML.
2005-05-27 18:16:58 +04:00
To do this, you'll need to install the rst2html and rst2man tools,
which are part of Docutils:
2005-05-27 18:16:58 +04:00
http://docutils.sourceforge.net/
2005-05-27 18:16:58 +04:00
The rst2man tool is not yet in a stable Docutils release, you have to
install their snapshot, which is what they recommend you run anyway:
http://docutils.sourceforge.net/docutils-snapshot.tgz
2005-05-27 18:16:58 +04:00
Use the Makefile in this directory to generate the man and HTML pages.