Mercurial > hg

view doc/README @ 9172:bc1de09090bc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: update README with links to Docutils
author Martin Geisler <mg@lazybytes.net>
date Sat, 18 Jul 2009 22:28:28 +0200
parents 8db8e1100f3f
children a4b761751919
line wrap: on
line source

Mercurial's documentation is kept in reStructuredText format, which is
a simple plain text format that's easy to read and edit:

  http://docutils.sourceforge.net/rst.html

It's also convertible to a variety of other formats including standard
UNIX man page format and HTML.

To do this, you'll need to install the rst2html and rst2man tools,
which are part of Docutils:

  http://docutils.sourceforge.net/

The rst2man tool is still in their so-called "sandbox". The above page
has links to tarballs of both Docutils and their sandbox.

Use the Makefile in this directory to generate the man and HTML pages.