From c1809d631dc2dc9e30894325680ff9f5396ccff8 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Fri, 12 Oct 2018 13:44:22 -0500 Subject: Merge duplicative RSB Quick Start into Users Guide --- user/start/index.rst | 50 +++++++++++++++++++++++++++++++++++--------------- 1 file changed, 35 insertions(+), 15 deletions(-) (limited to 'user/start') diff --git a/user/start/index.rst b/user/start/index.rst index f5e72ca..1016678 100644 --- a/user/start/index.rst +++ b/user/start/index.rst @@ -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 . - -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 ``...``. +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. -Create a workspace, download the RTEMS Source Builder (RSB) and build a tool -chain (:ref:`posix-host-tools-chain`): +Simple Example +============== .. code-block:: shell -- cgit v1.2.3