[489740f] | 1 | .. comment SPDX-License-Identifier: CC-BY-SA-4.0 |
---|
| 2 | |
---|
[4886d60] | 3 | .. Copyright (C) 2016 Chris Johns <chrisj@rtems.org> |
---|
[c05e43b] | 4 | |
---|
[3384994] | 5 | .. index:: Quick Start |
---|
| 6 | |
---|
[52f4890] | 7 | .. _QuickStart: |
---|
| 8 | |
---|
[86518bd] | 9 | Quick Start |
---|
[aa1c010] | 10 | *********** |
---|
[86518bd] | 11 | |
---|
| 12 | The following is a quick start guide that provides a basic set of commands to |
---|
| 13 | build the RTEMS Tools and Kernel. The quick start guide provides links to the |
---|
[c1809d6] | 14 | detailed sections if any problems are encountered. |
---|
[86518bd] | 15 | |
---|
[c1809d6] | 16 | The detailed procedure for installing an RTEMS Workspace and installing |
---|
| 17 | all tools can be found in :ref:`installation`. This includes information |
---|
| 18 | on installation points, developer versions, and the RTEMS kernel. |
---|
[86518bd] | 19 | |
---|
[c1809d6] | 20 | The short version of this procedure is as follows |
---|
| 21 | (:ref:`posix-host-tools-chain`): |
---|
[86518bd] | 22 | |
---|
[c1809d6] | 23 | #. Create a workspace (:ref:`installation`), |
---|
| 24 | |
---|
| 25 | #. Download the RTEMS Source Builder (RSB), |
---|
| 26 | |
---|
| 27 | #. Build an RTEMS tool chain for a specific target architecture, |
---|
| 28 | |
---|
| 29 | #. Download RTEMS, and then |
---|
[86518bd] | 30 | |
---|
[c1809d6] | 31 | #. Build RTEMS for a specific Board Support Package (BSP). |
---|
[86518bd] | 32 | |
---|
[c1809d6] | 33 | Each of these steps is described in a section in this guide. |
---|
| 34 | |
---|
| 35 | Creating a Workspace |
---|
| 36 | ==================== |
---|
| 37 | |
---|
| 38 | Before beginning, the development host computer needs to be set up for |
---|
| 39 | this quick start procedure to complete successfully. :ref:`host-computer` |
---|
| 40 | details what is needed for the supported host operating systems. If |
---|
| 41 | Windows is being used it is recommended following the procedure in |
---|
| 42 | :ref:`microsoft-windows` first. |
---|
| 43 | |
---|
| 44 | There are many ways and locations a suitable environment can be set up. A |
---|
| 45 | common factor that defines the final location of tools and projects is the |
---|
| 46 | place you have suitable storage. Another is permissions. There is no |
---|
| 47 | need to become root or the administrator and we recommend you avoid |
---|
| 48 | doing this. You can build and install the tools anywhere on the host's |
---|
| 49 | file system you, as a standard user, have read and write access too. |
---|
| 50 | :ref:`Prefixes` and :ref:`project-sandboxing` provide detailed examples |
---|
| 51 | of possible locations and set ups. |
---|
| 52 | |
---|
| 53 | Simple Example |
---|
| 54 | ============== |
---|
[86518bd] | 55 | |
---|
| 56 | .. code-block:: shell |
---|
| 57 | |
---|
| 58 | $ cd |
---|
| 59 | $ mkdir -p development/rtems |
---|
| 60 | $ cd development/rtems |
---|
| 61 | $ git clone git://git.rtems.org/rtems-source-builder.git rsb |
---|
| 62 | ... |
---|
| 63 | $ cd rsb |
---|
| 64 | $ ./source-builder/sb-check |
---|
| 65 | ... |
---|
| 66 | $ cd rtems |
---|
| 67 | $ ../source-builder/sb-set-builder \ |
---|
[60a6d6e] | 68 | --prefix=/usr/home/chris/development/rtems/5 5/rtems-sparc |
---|
[86518bd] | 69 | ... |
---|
| 70 | |
---|
| 71 | Build the RTEMS Kernel (:ref:`rtems-kernel-install`) by cloning the repository, |
---|
| 72 | running the ``bootstrap`` procecure, building and finally installing the |
---|
| 73 | kernel: |
---|
| 74 | |
---|
| 75 | .. code-block:: shell |
---|
| 76 | |
---|
[60a6d6e] | 77 | $ export PATH=$HOME/development/rtems/5/bin:$PATH |
---|
[86518bd] | 78 | $ cd |
---|
| 79 | $ cd development/rtems |
---|
| 80 | $ mkdir kernel |
---|
| 81 | $ cd kernel |
---|
| 82 | $ git clone git://git.rtems.org/rtems.git rtems |
---|
| 83 | ... |
---|
| 84 | $ cd rtems |
---|
[fc9db4c] | 85 | $ ./bootstrap -c && $HOME/development/rtems/rsb/source-builder/sb-bootstrap |
---|
[86518bd] | 86 | ... |
---|
| 87 | $ cd .. |
---|
| 88 | $ mkdir erc32 |
---|
| 89 | $ cd erc32 |
---|
[60a6d6e] | 90 | $ $HOME/development/rtems/kernel/rtems/configure --prefix=$HOME/development/rtems/5 \ |
---|
| 91 | --target=sparc-rtems5 --enable-rtemsbsp=erc32 --enable-posix |
---|
[86518bd] | 92 | ... |
---|
| 93 | $ make -j 8 |
---|
| 94 | ... |
---|
| 95 | $ make install |
---|
| 96 | |
---|
| 97 | You can now build a 3rd party library or an application. |
---|