doc/README
author Cesar Mena <cesarmena@gmail.com>
Sun, 22 Apr 2012 21:27:52 -0400
branchstable
changeset 16493 72c6240a4b7d
parent 9419 3516a4e877c1
permissions -rw-r--r--
encoding: protect against non-ascii default encoding If the default python encoding was changed from ascii, the attempt to encode as ascii before lower() could throw a UnicodeEncodeError. Catch UnicodeError instead to prevent an unhandled exception.

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.