1 | .. comment SPDX-License-Identifier: CC-BY-SA-4.0 |
---|
2 | |
---|
3 | .. comment: Copyright (c) 2016 Chris Johns <chrisj@rtems.org> |
---|
4 | .. comment: All rights reserved. |
---|
5 | |
---|
6 | Quick Start |
---|
7 | ============ |
---|
8 | |
---|
9 | The following is a quick start guide that provides a basic set of commands to |
---|
10 | build the RTEMS Tools and Kernel. The quick start guide provides links to the |
---|
11 | detailed sections if any problems are encoutnered. |
---|
12 | |
---|
13 | The detailed procedure for installing RTEMS can be found in |
---|
14 | :ref:`installation`. |
---|
15 | |
---|
16 | The development host computer needs to be set up for this quick start procedure |
---|
17 | to complete successfully. :ref:`host-computer` details what is needed for the |
---|
18 | supported host operating systems. If Windows is being used it is recommended |
---|
19 | following the procedure in :ref:`microsoft-windows` first. |
---|
20 | |
---|
21 | Their are many ways and locations a suitable environment can be set up. A |
---|
22 | common factor that defines the final location of tools and projects is the |
---|
23 | place you have suitable storage. :ref:`prefixes` and :ref:`project-sandboxing` |
---|
24 | provide detailed examples of possible locations and set ups . |
---|
25 | |
---|
26 | This procedure installs a developer set up using the RTEMS Git repositories on |
---|
27 | a Unix (POSIX) or MacOS host. The output from the commands has been removed and |
---|
28 | replaced with ``...``. |
---|
29 | |
---|
30 | Create a workspace, download the RTEMS Source Builder (RSB) and build a tool |
---|
31 | chain (: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 | |
---|
48 | Build the RTEMS Kernel (:ref:`rtems-kernel-install`) by cloning the repository, |
---|
49 | running the ``bootstrap`` procecure, building and finally installing the |
---|
50 | kernel: |
---|
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 | |
---|
75 | You can now build a 3rd party library or an application. |
---|