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