annotate doc/README @ 9627:4515761ea531

rst2man: avoid italic for references

The links to other manpages used both italic and bold text nested
within each other. The \fP (select previous font) macro was used
incorrectly to "reset" the nested fonts resulting in:

  <roman> text <italic> <bold> hg <italic> (1) <bold> more text

with no switch back to roman. This stops the bleeding and removes the
ugly italic (underline) from the manpage links.

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.