doc/README
author Martin von Zweigbergk <martinvonz@google.com>
Fri, 29 Sep 2017 14:49:05 -0700
changeset 34344 ac0cd81e2f83
parent 9419 3516a4e877c1
permissions -rw-r--r--
dirstate: use keyword arguments to clarify status()'s callers The arguments are especially non-obvious because the order is different from dirstate.walk(). Differential Revision: https://phab.mercurial-scm.org/D847

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.