44 Commits

Author SHA1 Message Date
Chris Johns
f6720264ea user: Update Quick Start Guide
- Add support for release source archives
- Add building the BSP using the RSB
- Add building packages using the RSB
- Add an application

Closes #2998
2020-03-13 08:18:36 +11:00
G S Niteesh
55d69ad1fb Updated docs to use the standalone SIS simulator, instead of GDB inbuilt SIS for the erc32 BSP. 2020-01-07 19:32:38 +01:00
Chris Johns
bb47f890c8 user/rsb: Update 3rd party package build and add packaging details. 2019-10-13 20:21:17 +11:00
Chris Johns
2674d6a949 user: Remove nit-picky warnings. 2019-02-28 10:22:54 +11:00
Sebastian Huber
f6be8a1ee1 user: Fix tense in quick start 2019-02-19 08:29:15 +01:00
Sebastian Huber
cb4e4e2b37 user: Remove obsolete content in quick start 2019-02-18 14:41:09 +01:00
Sebastian Huber
d7caf8acb6 user: Add "Build Your Application" 2019-02-18 14:41:09 +01:00
Sebastian Huber
d2827cbcb4 user: Add "Test a Board Support Package (BSP)" 2019-02-18 14:41:09 +01:00
Sebastian Huber
fa12cab2b9 user: Add "Build a Board Support Package (BSP)" 2019-02-18 14:41:09 +01:00
Sebastian Huber
158d905d77 user: Add "Bootstrap the RTEMS Sources" 2019-02-18 14:41:09 +01:00
Sebastian Huber
06a1fa27b7 user: Add "Install the Tool Suite" section 2019-02-18 14:41:06 +01:00
Sebastian Huber
947e8eb219 user: Add "Obtain the Sources" section 2019-02-18 14:03:11 +01:00
Sebastian Huber
eae5454288 user: Rework Prefixes section
Rename it to "Choose an Installation Prefix".

Update #3675.
2019-02-18 13:50:31 +01:00
Sebastian Huber
24456556d6 user: Fix references to prefixes section 2019-02-18 13:50:31 +01:00
Sebastian Huber
54ead99fc4 user: Rework "Host Computer Setup" section
Rename it to "Prepare Your Host Computer".
2019-02-18 13:50:25 +01:00
Sebastian Huber
63735bc9d2 user: Spell out third-party 2019-01-24 07:31:25 +01:00
Sebastian Huber
3ed59cebd8 user: Add "Host Computer Setup" to "Quick Start" 2019-01-14 07:15:27 +01:00
Sebastian Huber
0facb9de94 user: Move "Prefixes" to "Quick Start"
Move "Project Sandboxing" to a separate section of the "Installation"
chapter since this is an advance topic which may confuse new users.
2019-01-14 07:15:27 +01:00
Sebastian Huber
e52906b556 Simplify SPDX-License-Identifier comment 2019-01-11 07:22:01 +01:00
Sebastian Huber
12dccfe716 Remove superfluous "All rights reserved." 2019-01-11 07:18:56 +01:00
Sebastian Huber
4886d60aa8 Use standard format for copyright lines 2019-01-11 07:18:16 +01:00
Sebastian Huber
52f4890281 user: Rework overview
Move "Overview", "Real-time Applicaiton Systems" and "Real-time
Executive" chapters as sections into new "Introduction" chapter.  Add
"Feature" section.
2019-01-09 09:24:02 +01:00
Joel Sherrill
c1809d631d Merge duplicative RSB Quick Start into Users Guide 2018-10-13 20:06:50 -05:00
Sebastian Huber
fc9db4c26e user: Do not mention "bootstrap -p"
It is now obsolete and was never necessary for an RTEMS users.

Update #3254.
2018-03-28 07:21:14 +02:00
Chris Johns
33849946ff Clean up sphinx warnings.
- Fix minor formatting issues.
- Fix reference the gloassary TLS using ':term:'.
- Make sure nothing is between an anchor and the heading where ':ref:' references
  the anchor. This meant moving all the recently added '.. index::' entries.

Update #3232.
Update #3229.
2017-11-13 13:25:18 +11:00
Chris Johns
ac0eaff941 Use '.. toctree::' and not '.. include::' in the User Manual.
- Change all suitable '.. include::' to TOC tree.
- Remove unused and not needed sections.
- Fix the conf.py to not exclude some files.

Close #3232.
2017-11-13 11:51:23 +11:00
Sebastian Huber
60a6d6eae9 Change RTEMS version to 5
Update #3220.
2017-11-09 10:24:09 +01:00
Chris Johns
aa1c010e31 user: Fix header levels. 2016-11-09 12:20:46 +11:00
Chris Johns
86518bd3dd Reorganisse the User Manual to make it easier to navigate. 2016-07-04 12:30:09 +10:00
Chris Johns
489740f6a9 Set SPDX License Identifier in each source file. 2016-05-20 12:47:09 +10:00
Amar Takhar
170418af2d Move images to a common directory. 2016-05-18 13:47:42 -04:00
Chris Johns
ea0777e4ee Review changes from Chris Mayfield. 2016-05-02 20:51:27 -04:00
Chris Johns
aae09e24ae Corrections from Worth Burruss. Many thanks. 2016-05-02 20:51:27 -04:00
Chris Johns
a34c157d08 Corrections from Worth Burruss. Many thanks. 2016-05-02 20:51:27 -04:00
Chris Johns
6958370ed9 Fix bad formatting that somehow went into the doco. 2016-05-02 20:51:27 -04:00
Chris Johns
dc234b58f4 Corrections from a review. 2016-05-02 20:51:27 -04:00
Chris Johns
c075916ddc Corrections and improvements from Worth Burruss (thanks so much). 2016-05-02 20:51:27 -04:00
Chris Johns
21519275cc Corrections. 2016-05-02 20:51:27 -04:00
Chris Johns
27bcdfbf57 Add a basics section to Getting Started. Rearrange the content. 2016-05-02 20:51:27 -04:00
Chris Johns
024e04034e Start adding Getting Started guide's Released Version. 2016-05-02 20:51:27 -04:00
Chris Johns
5353914b84 Updates from user reviews. 2016-05-02 20:51:27 -04:00
Chris Johns
4e3cf2b2f8 Split installation into separate files. 2016-05-02 20:51:26 -04:00
Chris Johns
c05e43b4a3 User manual, devel install and windows install. 2016-05-02 20:51:26 -04:00
Amar Takhar
5daabd23cf Initial reST documentation using Sphinx. 2016-05-02 20:51:07 -04:00