doc/README
author Pierre-Yves David <pierre-yves.david@ens-lyon.org>
Fri, 06 Jan 2012 11:20:49 +0100
changeset 15823 a1f818a2b50d
parent 9419 3516a4e877c1
permissions -rw-r--r--
phases: ``{phase}`` template keyword display the phase name ``{phaseidx}`` is providing the phase index as integer. This integer representation is useful when people need to use the fact that phase are ordered. Test keep using the number version for readability purpose.

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. You'll need to install Docutils:

  http://docutils.sourceforge.net/

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