Mercurial > hg
annotate doc/README @ 14461:f5b0834cf685
gendoc: config help topic is in hgrc.5, do not include it in hg.1
author | Martin Geisler <mg@lazybytes.net> |
---|---|
date | Mon, 30 May 2011 11:18:47 +0200 |
parents | 3516a4e877c1 |
children |
rev | line source |
---|---|
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
1 Mercurial's documentation is kept in reStructuredText format, which is |
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
2 a simple plain text format that's easy to read and edit: |
177 | 3 |
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
4 http://docutils.sourceforge.net/rst.html |
177 | 5 |
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
6 It's also convertible to a variety of other formats including standard |
9419
3516a4e877c1
doc/README: simplify instructions
Martin Geisler <mg@lazybytes.net>
parents:
9406
diff
changeset
|
7 UNIX man page format and HTML. You'll need to install Docutils: |
177 | 8 |
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
9 http://docutils.sourceforge.net/ |
177 | 10 |
9172
bc1de09090bc
doc: update README with links to Docutils
Martin Geisler <mg@lazybytes.net>
parents:
5048
diff
changeset
|
11 Use the Makefile in this directory to generate the man and HTML pages. |