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

Merge duplicative RSB Quick Start into Users Guide

Browse Source
This commit is contained in:
Joel Sherrill
2018-10-12 13:44:22 -05:00
parent d40e66b2e9
commit c1809d631d
8 changed files with 312 additions and 558 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
user/start/index.rst
View File

@@ -10,27 +10,47 @@ Quick Start
The following is a quick start guide that provides a basic set of commands to
build the RTEMS Tools and Kernel. The quick start guide provides links to the
detailed sections if any problems are encoutnered.
detailed sections if any problems are encountered.
The detailed procedure for installing RTEMS can be found in
:ref:`installation`.
The detailed procedure for installing an RTEMS Workspace and installing
all tools can be found in :ref:`installation`. This includes information
on installation points, developer versions, and the RTEMS kernel.
The development host computer needs to be set up for this quick start procedure
to complete successfully. :ref:`host-computer` details what is needed for the
supported host operating systems. If Windows is being used it is recommended
following the procedure in :ref:`microsoft-windows` first.
The short version of this procedure is as follows
(:ref:`posix-host-tools-chain`):
#. Create a workspace (:ref:`installation`),
#. Download the RTEMS Source Builder (RSB),
#. Build an RTEMS tool chain for a specific target architecture,
#. Download RTEMS, and then
#. Build RTEMS for a specific Board Support Package (BSP).
Each of these steps is described in a section in this guide.
Creating a Workspace
====================
Before beginning, the development host computer needs to be set up for
this quick start procedure to complete successfully. :ref:`host-computer`
details what is needed for the supported host operating systems. If
Windows is being used it is recommended following the procedure in
:ref:`microsoft-windows` first.
There are many ways and locations a suitable environment can be set up. A
common factor that defines the final location of tools and projects is the
place you have suitable storage. :ref:`Prefixes` and :ref:`project-sandboxing`
provide detailed examples of possible locations and set ups .
place you have suitable storage. Another is permissions. There is no
need to become root or the administrator and we recommend you avoid
doing this. You can build and install the tools anywhere on the host's
file system you, as a standard user, have read and write access too.
:ref:`Prefixes` and :ref:`project-sandboxing` provide detailed examples
of possible locations and set ups.
This procedure installs a developer set up using the RTEMS Git repositories on
a Unix (POSIX) or MacOS host. The output from the commands has been removed and
replaced with ``...``.
Create a workspace, download the RTEMS Source Builder (RSB) and build a tool
chain (:ref:`posix-host-tools-chain`):
Simple Example
==============
.. code-block:: shell