rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-07-05 04:33:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

README: fix typos

Browse Source
This commit is contained in:
Gedare Bloom 2017-07-26 11:44:44 -04:00
parent f776fe6591
commit 5ffa0722e4
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.txt
View File

@ -322,7 +322,7 @@ existing documentation for an example and if unsure ask.
6 ~~~~~~ Sub-sub-sub-sub-section 6 ~~~~~~ Sub-sub-sub-sub-section
5. For literal output, such as shell commands and code use '::' at the trailing 5. For literal output, such as shell commands and code use '::' at the trailing
edge of the previous paragraph. If the '.. code-block::' with edge of the previous paragraph. Use the '.. code-block::' with
'c' for C code and 'shell' for shell code and terminal output. If you need 'c' for C code and 'shell' for shell code and terminal output. If you need
line number use: line number use:
@ -337,7 +337,7 @@ existing documentation for an example and if unsure ask.
.. note:: .. note::
.. topic:: .. topic::
These directives reference specific CSS sytle support. These directives reference specific CSS style support.
7. Images are placed in the 'images' directory. Do not place images in the 7. Images are placed in the 'images' directory. Do not place images in the
source directories. Using a common 'images' tree of images promotes sharing source directories. Using a common 'images' tree of images promotes sharing
@ -348,7 +348,7 @@ existing documentation for an example and if unsure ask.
:align: center :align: center
:alt: This is the alt text for some output types. :alt: This is the alt text for some output types.
8. Callouts can be implement manually using a liternal block which can using 8. Callouts can be implemented manually using a literal block which can use
'::' or a code block and topic block is used for the items. For '::' or a code block and topic block is used for the items. For
example: example:
@ -369,13 +369,13 @@ existing documentation for an example and if unsure ask.
3. Print something to the standard output device. 3. Print something to the standard output device.
4. Exit with an exit code of 0. This is value can be checked by the 4. Exit with an exit code of 0. This value can be checked by the
caller of this program. caller of this program.
Note, the topic items are manually number. This makes is easier to see which Note, the topic items are manually numbered, which makes it easier to see
item matches the text. Use <> for the number and align at a position that which item matches the text. Use <> for the number and align at a position
works and makes the number as visible as possible. Use hanging indents if an that works and makes the number as visible as possible. Use hanging indents
items extends over a single line. if an items extends past a single line.
9. Use the RTEMS domain references for URLs and mailing lists. For example to 9. Use the RTEMS domain references for URLs and mailing lists. For example to
insert the RTEMS developers list use: insert the RTEMS developers list use: