Changeset 86518bd in rtems-docs for user/start/index.rst


Ignore:
Timestamp:
Jul 4, 2016, 2:30:09 AM (4 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
4.11, master
Children:
f92357f
Parents:
6d7a4d2
Message:

Reorganisse the User Manual to make it easier to navigate.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • user/start/index.rst

    r6d7a4d2 r86518bd  
    44.. comment: All rights reserved.
    55
    6 ===============
    7 Getting Started
    8 ===============
     6Quick Start
     7============
    98
    10 RTEMS is an open source real-time operating system. As a user you have access
    11 to all the source code. This ``Getting Started`` section will show you how you
    12 build the RTEMS compiler tools, kernel and 3rd party libraries from source.
     9The following is a quick start guide that provides a basic set of commands to
     10build the RTEMS Tools and Kernel. The quick start guide provides links to the
     11detailed sections if any problems are encoutnered.
    1312
    14 .. include:: basics.rst
    15 .. include:: depend.rst
    16 .. include:: installation.rst
    17 .. include:: releases.rst
    18 .. include:: development.rst
    19 .. include:: windows.rst
     13The detailed procedure for installing RTEMS can be found in
     14:ref:`installation`.
     15
     16The development host computer needs to be set up for this quick start procedure
     17to complete successfully. :ref:`host-computer` details what is needed for the
     18supported host operating systems. If Windows is being used it is recommended
     19following the procedure in :ref:`microsoft-windows` first.
     20
     21Their are many ways and locations a suitable environment can be set up. A
     22common factor that defines the final location of tools and projects is the
     23place you have suitable storage. :ref:`prefixes` and :ref:`project-sandboxing`
     24provide detailed examples of possible locations and set ups .
     25
     26This procedure installs a developer set up using the RTEMS Git repositories on
     27a Unix (POSIX) or MacOS host. The output from the commands has been removed and
     28replaced with ``...``.
     29
     30Create a workspace, download the RTEMS Source Builder (RSB) and build a tool
     31chain (:ref:`posix-host-tools-chain`):
     32
     33.. code-block:: shell
     34
     35  $ cd
     36  $ mkdir -p development/rtems
     37  $ cd development/rtems
     38  $ git clone git://git.rtems.org/rtems-source-builder.git rsb
     39    ...
     40  $ cd rsb
     41  $ ./source-builder/sb-check
     42    ...
     43  $ cd rtems
     44  $ ../source-builder/sb-set-builder \
     45      --prefix=/usr/home/chris/development/rtems/4.12 4.12/rtems-sparc
     46    ...
     47
     48Build the RTEMS Kernel (:ref:`rtems-kernel-install`) by cloning the repository,
     49running the ``bootstrap`` procecure, building and finally installing the
     50kernel:
     51
     52.. code-block:: shell
     53
     54  $ export PATH=$HOME/development/rtems/4.12/bin:$PATH
     55  $ cd
     56  $ cd development/rtems
     57  $ mkdir kernel
     58  $ cd kernel
     59  $ git clone git://git.rtems.org/rtems.git rtems
     60    ...
     61  $ cd rtems
     62  $ ./bootstrap -c && ./bootstrap -p && \
     63              $HOME/development/rtems/rsb/source-builder/sb-bootstrap
     64    ...
     65  $ cd ..
     66  $ mkdir erc32
     67  $ cd erc32
     68  $ $HOME/development/rtems/kernel/rtems/configure --prefix=$HOME/development/rtems/4.12 \
     69                     --target=sparc-rtems4.12 --enable-rtemsbsp=erc32 --enable-posix
     70    ...
     71  $ make -j 8
     72    ...
     73  $ make install
     74
     75You can now build a 3rd party library or an application.
Note: See TracChangeset for help on using the changeset viewer.