doc/README
author Jason R. Coombs <jaraco@jaraco.com>
Wed, 07 Sep 2022 14:56:45 -0400
changeset 49493 4367c46a89ee
parent 9419 3516a4e877c1
permissions -rw-r--r--
requires: re-use vfs.tryread for simplicity Avoids calling `set` twice or having to re-raise an exception and implements the routine with a single return expression.

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.