doc/README
author Gregory Szorc <gregory.szorc@gmail.com>
Sat, 02 Jan 2016 15:14:55 -0800
changeset 27632 9fea6b38a8da
parent 9419 3516a4e877c1
permissions -rw-r--r--
streamclone: use read() We have a convenience API for reading the full contents of a file. Use it.

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.