| author | Arseniy Alekseyev <aalekseyev@janestreet.com> |
| Tue, 16 Apr 2024 13:51:45 +0100 | |
| changeset 51604 | 32ba01b5669d |
| parent 9419 | 3516a4e877c1 |
| permissions | -rw-r--r-- |
|
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. |