-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.md.in
194 lines (147 loc) · 6.82 KB
/
README.md.in
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
--------------------------------------------------------------------------------
**Home:** <@RELEASE_URL@>
**Release:** @RELEASE@
**Date:** @DATE@
--------------------------------------------------------------------------------
[RN-H]: rtems-@RELEASE@-release-notes
[RN-P]: rtems-@[email protected]
[RN-J]: rtems-@[email protected]
The Real-Time Executive for Multiprocessor Systems or RTEMS is an open source
Real Time Operating System (RTOS) that supports open standard application
programming interfaces (API) such as POSIX. It is used in space flight,
medical, networking and many more embedded devices using processor
architectures including ARM, PowerPC, SPARC, Intel, RISCV, MIPS, NIOS-II,
Microblaze and more (a full list is provided at the end).
This release directory contains the source code for the RTEMS @RELEASE@
operating system and tools. All the documenation provided in HTML and PDF
formats.
Please drop by the Users mailing list ([email protected]) and let us know how
you are using RTEMS. We love hearing about user projects.
Many thanks to everyone who helped create this release.
Regards
*The RTEMS Development Team.*
## RTEMS Web Sites
--------- ------------------------------------------
Home <https://www.rtems.org/>
Download <https://ftp.rtems.org/pub/rtems/releases>
Docs <https://docs.rtems.org/>
Developer <https://gitlab.rtems.org/>
Discord <https://www.rtems.org/discord>
Lists <https://lists.rtems.org/>
--------- ------------------------------------------
## Release Files
---------------------------------------------------------------------------------
@RELEASE@ @R_SP@ Top level directory
------------------------------------------ --------------------------------------
[README.txt](README.txt), `index.html` This document
[contrib](contrib) Directory contains extra release
related files
[docs](docs) The generated RTEMS documentation
[sources](sources) Source code for this release
[rtems-@RELEASE@-release-notes][RN-H] @R_SP@ HTML RTEMS Release notes
[rtems-@[email protected]][RN-P] @R_SP@ PDF RTEMS Release notes
[rtems-@[email protected]][RN-J] @R_SP@ RTEMS Release notes data (JSON)
[sha512sum.txt](sha512sum.txt) The SHA512 checksums for this
directory
---------------------------------------------------------------------------------
[S-RSB]: sources/rtems-source-builder-@[email protected]
[S-DEPLOY]: sources/rtems-deployment-@[email protected]
[S-K]: sources/rtems-@[email protected]
[S-T]: sources/rtems-tools-@[email protected]
[S-DOC]: sources/rtems-docs-@[email protected]
[S-BSD]: sources/rtems-libbsd-@[email protected]
[S-EX]: sources/rtems-examples-@[email protected]
[S-CS]: sources/sha512sum.txt
Source Downloads | RTEMS Source Code
-----------------------------------------------|---------------------------------------
[rtems-@[email protected]][S-K] | RTEMS kernel
[rtems-source-builder-@[email protected]][S-RSB] | RTEMS Source Builder
[rtems-deployment-@[email protected]][S-DEPLOY] | RTEMS Deployment
[rtems-tools-@[email protected]][S-T] | RTEMS Tools
[rtems-docs-@[email protected]][S-DOC] | RTEMS Documentation source
[rtems-libbsd-@[email protected]][S-BSD] | RTEMS LibBSD
[rtems-examples-@[email protected]][S-EX] | RTEMS Examples
[sources](sources) | All source code for this release
[sha512sum.txt][S-CS] | SHA512 checksums for the sources directory
## RTEMS Documentation
[D-O]: docs/html
[D-U-O]: docs/html/user
[D-U-P]: docs/rtems-@[email protected]
[D-U-H]: docs/rtems-@[email protected]
[D-C-O]: docs/html/c-user
[D-C-P]: docs/rtems-@[email protected]
[D-C-H]: docs/rtems-@[email protected]
[D-P-O]: docs/html/posix-users
[D-P-P]: docs/rtems-@[email protected]
[D-P-H]: docs/rtems-@[email protected]
[D-E-O]: docs/html/eng
[D-E-P]: docs/rtems-@[email protected]
[D-E-H]: docs/rtems-@[email protected]
[D-N-O]: docs/html/networking
[D-N-P]: docs/rtems-@[email protected]
[D-N-H]: docs/rtems-@[email protected]
[D-S-O]: docs/html/shell
[D-S-P]: docs/rtems-@[email protected]
[D-S-H]: docs/rtems-@[email protected]
[D-O-O]: docs/html/doxygen
[D-O-H]: docs/rtems-@[email protected]
[Online RTEMS @RELEASE@ Documentation][D-O]
The generated documentation packages can be found in the `docs` directory.
The following manuals are available as compressed HTML tar files or PDF:
RTEMS User Manual
~ * [docs/html/user][D-U-O]
* [docs/rtems-@[email protected]][D-U-P]
* [docs/rtems-@[email protected]][D-U-H]
RTEMS C User Manual
~ * [docs/html/c-user][D-C-O]
* [docs/rtems-@[email protected]][D-C-P]
* [docs/rtems-@[email protected]][D-C-H]
RTEMS POSIX User Manual
~ * [docs/html/posix-users][D-P-O]
* [docs/rtems-@[email protected]][D-P-P]
* [docs/rtems-@[email protected]][D-P-H]
RTEMS Software Engineering Manual
~ * [docs/html/eng][D-E-O]
* [docs/rtems-@[email protected]][D-E-P]
* [docs/rtems-@[email protected]][D-E-H]
RTEMS Networking User Manual
~ * [docs/html/networking][D-N-O]
* [docs/rtems-@[email protected]][D-N-P]
* [docs/rtems-@[email protected]][D-N-H]
RTEMS Shell User Manual
~ * [docs/html/shell][D-S-O]
* [docs/rtems-@[email protected]][D-S-P]
* [docs/rtems-@[email protected]][D-S-H]
RTEMS Doxygen
~ * [docs/html/doxygen][D-O-O]
* [docs/rtems-@[email protected]][D-O-H]
## Quick Guide to Building
For new user the Quick Start in the User Manual contains a details Quick Start
guide. Download the User Manual:
<@RELEASE_URL@/docs/rtems-@[email protected]>
and follow the instructions in the Quick Start section. If are familiar with
RTEMS or just want to get going the following steps will download the RTEMS
Source Builder:
~~~~~~~
cd
mkdir -p development/rtems
cd development/rtems
wget @RELEASE_URL@/sources/rtems-source-builder-@[email protected]
tar Jxf rtems-source-builder-@[email protected]
cd rtems-source-builder-@RELEASE@/rtems
~~~~~~~
To build the tools for the ARM architecture:
~~~~~~~
../source-builder/sb-set-builder \
--prefix=$HOME/development/rtems/@RELEASE@ \
@VERSION@/rtems-arm
~~~~~~~
To build the tools, kernel and all packages for the Beagleboneblack:
~~~~~~~
../source-builder/sb-set-builder \
--prefix=$HOME/development/rtems/@RELEASE@ \
@VERSION@/bsps/beagleboneblack
~~~~~~~
If you encounter a problem please post to the [email protected] mailing list. You
can join the Users mailing at <https://lists.rtems.org/>.
If you find a bug please raise an issue at https://gitlab.rtems.org/rtems/