doc/README
author Christian Ebert <blacktrash@gmx.net>
Wed, 05 Aug 2009 17:20:47 +0200
changeset 9306 7bd1b663727d
parent 9172 bc1de09090bc
child 9406 a4b761751919
permissions -rw-r--r--
keyword: remove "help keyword" from test Testing help output does not make sense as we have no way to check for errors in content which would be the only reasonable test here.

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.