rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-05-15 01:37:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

README.txt: Fix grammar errors (GCI 2018)

Browse Source
This commit is contained in:
Aneendya 2018-11-16 10:49:24 -06:00 committed by Joel Sherrill
parent 3f4f904296
commit 11d977b916
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.txt
View File

@ -6,8 +6,8 @@ check the version of Sphinx and ensure you have a suitable version
available. If your host does not provide a packaged version use PIP to fetch a
recent version. The Sphinx website provides details on doing this.
ReST is the Re-Structed-Text format. It is a simple markup language that allows
us to create quality documentaion. It is flexible and powerful however do not
ReST is the Re-Structured-Text format. It is a simple markup language that allows
us to create quality documentaion. It is flexible and powerful however does not
attempt to train it to create a specific format. You need to test any new way
of presenting something on all output formats. What may look great in one
format may not translate with the same clarity to another output format.
@ -16,7 +16,7 @@ The RTEMS Documentation output formats are:
HTML - Multi-page HTML with files in a single directory per manual.
PDF - Single PDF per manual.
SIngle HTML - Single HTML, one file per manual.
Single HTML - Single HTML, one file per manual.
The PDF format is created using Latex and that uses texlive packages. This
exposes us to the complex world of Latex however the quality of the documents