summaryrefslogtreecommitdiffstats
path: root/README.txt
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2016-11-09 12:21:00 +1100
committerChris Johns <chrisj@rtems.org>2016-11-09 12:21:00 +1100
commit356b0ec21c9b5d8155922aed9bc706e9d79f8b43 (patch)
treea1157ac09ee03e703aec142ba1043d2c705a8011 /README.txt
parentaa1c010e313ed4067e4d477f048cc6f0350b5e97 (diff)
downloadrtems-docs-356b0ec21c9b5d8155922aed9bc706e9d79f8b43.tar.bz2
README: Fix the header levels.
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt14
1 files changed, 8 insertions, 6 deletions
diff --git a/README.txt b/README.txt
index 6e94c50..180b944 100644
--- a/README.txt
+++ b/README.txt
@@ -93,7 +93,7 @@ Sphinx:
PDF:
WARNING: Do NOT use the RPMs for texlive. They are incomplete and, in
- the best case, result in ugly PDFs.
+ the best case, result in ugly PDFs.
As root, install texlive per the instructions at
http://tug.org/texlive/acquire-netinstall.html
@@ -264,11 +264,13 @@ existing documentation for an example and if unsure ask.
3. The headings use the following:
- Heading
- 1 ======
- 2 ------
- 3 ~~~~~~
- 4 ^^^^^^
+ Heading Description
+ 1 ###### Part
+ 2 ****** Section
+ 3 ====== Sub-ection
+ 4 ------ Sub-sub-section
+ 5 ^^^^^^ Sub-sub-sub-section
+ 6 ~~~~~~ Sub-sub-sub-sub-section
3. For literal output, such as shell commands and code use '::' at the trailing
edge of the previous paragraph. If the '.. code-block::' with