source: rtems-release/README.txt.in @ db2c683

5
Last change on this file since db2c683 was db2c683, checked in by Chris Johns <chrisj@…>, on Oct 29, 2019 at 4:27:17 AM

Update to support RTEMS 5

  • Property mode set to 100644
File size: 4.0 KB
Line 
1RTEMS Embedded Realtime Operating System
2----------------------------------------
3
4Release: @RELEASE@
5Date   : @DATE@
6
7The Real-Time Executive for Multiprocessor Systems or RTEMS is an open
8source Real Time Operating System (RTOS) that supports open standard
9application programming interfaces (API) such as POSIX. It is used in
10space flight, medical, networking and many more embedded devices using
11processor architectures including ARM, PowerPC, SPARC, Intel, RISCV,
12MIPS, NIOS-II, Microblaze and more.
13
14This directory contains the source code for the RTEMS @VERSION@ operating
15system and tools. Please refer to the RTEMS Developers Wiki for the release
16notes.
17
18Please drop by the Users mailing list (users@rtems.org) and let us know how you
19are using RTEMS. We love hearing about user's projects.
20
21Many thanks to everyone who helped create this release.
22
23Regards
24The RTEMS Development Team.
25
26RTEMS Web Sites
27~~~~~~~~~~~~~~~
28
29      Home: https://www.rtems.org/
30Developers: https://devel.rtems.org/
31      Docs: https://docs.rtems.org/
32       Bug: https://devel.rtems.org/query
33     Lists: https://lists.rtems.org/
34       GIT: https://git.rtems.org/
35
36Release Files
37~~~~~~~~~~~~~
38
39 - README.txt                                   This document.
40 - contrib                                      Directory contains extra release related files.
41 - rtems-@RELEASE@-release-notes.pdf               The RTEMS Release notes.
42 - rtems-@RELEASE@.tar.xz                          The RTEMS kernel source code.
43 - rtems-source-builder-@RELEASE@.tar.xz           The RTEMS Source Builder source code.
44 - rtems-tools-@RELEASE@.tar.xz                    The RTEMS Tools source code.
45 - rtems-docs-@RELEASE@.tar.xz                     The RTEMS Documentation source.
46 - rtems-libbsd-@RELEASE@.tar.xz                   The RTEMS LibBSD source.
47 - rtems-doxygen-@RELEASE@.tar.xz                  The RTEMS CPU Kit doxygen documentation.
48 - rtems-examples-v2-@RELEASE@.tar.xz              The RTEMS Examples source.
49 - sha512sum.txt                                The SHA512 checksums for this directory.
50 - docs                                         The generated RTEMS documentation.
51 - sources                                      The source code the tools for this release.
52
53RTEMS Documentation
54~~~~~~~~~~~~~~~~~~~
55
56The generated documentation can be found in the `docs` directory.
57
58The following manuals are available as compress HTML tar files or PDF:
59
60 - RTEMS User Manual
61  - docs/rtems-docs-@RELEASE@-user.pdf
62  - docs/rtems-docs-@RELEASE@-user-html.tar.xz
63
64 - RTEMS C User Manual
65  - docs/rtems-docs-@RELEASE@-c-user.pdf
66  - docs/rtems-docs-@RELEASE@-c-user-html.tar.xz
67
68 - RTEMS POSIX User Manual
69  - docs/rtems-docs-@RELEASE@-posix-user.pdf
70  - docs/rtems-docs-@RELEASE@-posix-user-html.tar.xz
71
72 - RTEMS Networking User Manual
73  - docs/rtems-docs-@RELEASE@-networking.pdf
74  - docs/rtems-docs-@RELEASE@-networking-html.tar.xz
75
76 - RTEMS Shell User Manual
77  - docs/rtems-docs-@RELEASE@-shell.pdf
78  - docs/rtems-docs-@RELEASE@-shell-html.tar.xz
79
80Quick Guide to Building
81~~~~~~~~~~~~~~~~~~~~~~~
82
83To build the tools and kernel for an architecture download:
84
85  rtems-source-builder-@RELEASE@.tar.xz
86
87Please check to the RSB documentation (https://docs.rtems.org/rsb/) and the
88Wiki (TBD) if you have any issues.
89
90If you encounter a problem please post to the user@rtems.org mailing list and
91if you find a bug please raise a ticket (https://devel.rtems.org/newticket).
92
93The following builds RTEMS for the SPARC architecture:
94
95 $ cd
96 $ mkdir development/rtems
97 $ cd development/rtems
98 $ tar Jxf rtems-source-builder-@RELEASE@.tar.xz
99 $ cd rtems-source-builder-@RELEASE@/rtems
100 $ ../source-builder/sb-set-builder \
101         --prefix=$HOME/development/rtems/@RELEASE@ \
102         @VERSION@/rtems-sparc
103
104To disable building the RTEMS Kernel add to the command line '--without-rtems'.
105
106To build a single BSP add to the command line '--with-rtemsbsp'. You can
107specify more than one BSP with quotes and a space delimiting the BSP names. By
108default all BSPs for an architecture are built.
Note: See TracBrowser for help on using the repository browser.