doc/README

interfaces: convert the dirstate zope interface to a Protocol class

This is a small trial run for converting the repository interfaces enmasse, in
the same series of steps.  I'm not sure that this current code is valid (it has
zope attribute fields, and it's missing all of the `self` args on its functions,
but that was the previous state of things, and made PyCharm really unhappy).
But it will be easier to review the repository interface changes if this change
is separate from adding `self` and dropping the zope attributes all over.

Having an empty constructor in a protocol is weird.  I'm not sure if these args
should be converted to fields that all subclasses would have, and comments
around existing attributes say some should be going away.  Comment it out for
now so that it's not in the way, but also not forgotten.

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.