diff options
| author | Chris Johns <chrisj@rtems.org> | 2016-11-09 22:57:50 +0000 |
|---|---|---|
| committer | Chris Johns <chrisj@rtems.org> | 2016-11-09 23:00:14 +0000 |
| commit | f37080084ad9e5cffd935e5e54b7a6452b318da2 (patch) | |
| tree | c30f5129f9a0d3ab58ff9963ab4a506d2debb8c6 /README-4.10.txt.in | |
| parent | Add /path/to/ to the example instructions for untaring rtems-source-builder i... (diff) | |
| download | rtems-release-f37080084ad9e5cffd935e5e54b7a6452b318da2.tar.bz2 | |
Fix the doco and packaging of docs. Sort out the README.txt templates.
Diffstat (limited to 'README-4.10.txt.in')
| -rw-r--r-- | README-4.10.txt.in | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/README-4.10.txt.in b/README-4.10.txt.in new file mode 100644 index 0000000..3c8d478 --- /dev/null +++ b/README-4.10.txt.in @@ -0,0 +1,75 @@ +RTEMS Embedded Realtime Operating System +---------------------------------------- + +Release: @RELEASE@ +Date : @DATE@ + +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, Intel, Blackfin, MIPS, Microblaze and +more. + +This directory contains the source code for the RTEMS @VERSION@ operating +system and tools. Please refer to the RTEMS Developers Wiki for the release +notes. + +Please drop by the Users mailing list (users@rtems.org) and let us know how you +are using RTEMS. We love hearing about user's projects. + +Many thanks to everyone who helped create this release. + +Regards +The RTEMS Development Team. + +RTEMS Web Sites +~~~~~~~~~~~~~~~ + + Home: https://www.rtems.org/ +Developers: https://devel.rtems.org/ + Docs: https://docs.rtems.org/ + Bug: https://devel.rtems.org/query + Lists: https://lists.rtems.org/ + GIT: https://git.rtems.org/ + +Release Files +~~~~~~~~~~~~~ + + - README.txt This document. + - contrib Directory contains extra release related files. + - rtems-@RELEASE@.tar.xz The RTEMS kernel source code. + - rtems-source-builder-@RELEASE@.tar.xz The RTEMS Source Builder source code. + - rtems-tools-@RELEASE@.tar.xz The RTEMS Tools source code. + - sha512sum.txt The SHA512 checksums for this directory. + - sources The source code the tools for this release. + +Quick Guide to Building +~~~~~~~~~~~~~~~~~~~~~~~ + +To build the tools and kernel for an architecture download: + + rtems-source-builder-@RELEASE@.tar.xz + +Please check to the RSB documentation (https://docs.rtems.org/rsb/) and the +Wiki (TBD) if you have any issues. + +If you encounter a problem please post to the user@rtems.org mailing list and +if you find a bug please raise a ticket (https://devel.rtems.org/newticket). + +The following builds RTEMS for the SPARC architecture: + + $ cd + $ mkdir development/rtems + $ cd development/rtems + $ tar Jxf /path/to/rtems-source-builder-@RELEASE@.tar.xz + $ cd rtems-source-builder-@RELEASE@/rtems + $ ../source-builder/sb-set-builder \ + --prefix=$HOME/development/rtems/@RELEASE@ \ + @VERSION@/rtems-sparc + +To disable building the RTEMS Kernel add to the command line '--without-rtems'. + +To build a single BSP add to the command line '--with-rtemsbsp'. You can +specify more than one BSP with quotes and a space delimiting the BSP names. By +default all BSPs for an architecture are built. |