Changes between Version 1 and Version 2 of GCI/Documentation/BuildRTEMSDocumentation

Timestamp:

10/24/18 16:39:54 (5 years ago)

Author:

Joel Sherrill

Comment:

--

GCI/Documentation/BuildRTEMSDocumentation

@@ -9 +9 @@
 Download the source code for the RTEMS documentation by using git clone as follows:
 
-{{
+
+{{{
 git clone git://git.rtems.org/rtems-docs.git
-}}
+}}}
 
-Follow the instructions in the file README.txt in the top of the source tree. It provides guidance on installing the needed tools on various host operating systems. It does not include guidance for as many hosts as the instructions for building RTEMS do. A critical part of this task is helping the RTEMS Project improve these instructions.
+Follow the instructions in the file README.txt in the top of the ''rtems-docs'' source tree. It provides guidance on installing the needed tools on various host operating systems. It does not include guidance for as many hosts as the instructions for building RTEMS do. A critical part of this task is helping the RTEMS Project improve these instructions.
 
 Another purpose of this task is to enable you to be able to modify the documentation in subsequent tasks and submit changes. The [wiki:GCI/Coding/HelloWorld] task includes guidance on using git that will be helpful here.
 
 Edit a page in the Users Guide and produce a PDF file of that document. Submit that PDF along with a patch as proof.
+
+Remember that an important part of this task is making the process of building the documentation easier for the next person. Suggest improvements to the README.txt, give us information on host operating systems that are not included, etc..
 
 == Feedback ==