Mercurial > hg

view doc/README @ 12813:13fdef670c43 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
gendoc: support multi-line synopses
author Martin Geisler <mg@lazybytes.net>
date Sat, 23 Oct 2010 00:11:39 +0200
parents 3516a4e877c1
children
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. You'll need to install Docutils:

  http://docutils.sourceforge.net/

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