summaryrefslogtreecommitdiffstats
path: root/README.txt.in
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2020-04-02 17:41:46 +1100
committerChris Johns <chrisj@rtems.org>2020-04-02 17:41:46 +1100
commitdb971a69cc5d18dc5692ea672f6d3e1633e7fe49 (patch)
tree1c0be92028089bea2a52c3e3ba3f7816061cff33 /README.txt.in
parentcron: Remove the debug exit code clearing. (diff)
downloadrtems-release-db971a69cc5d18dc5692ea672f6d3e1633e7fe49.tar.bz2
Move all source into `sources`
- Update the README.txt to reference all the sources in the `sources` directory. Also fix the table formatting. - Add support for a release url to aid test and support deployment. - Make the docs and sources directory defaults
Diffstat (limited to 'README.txt.in')
-rw-r--r--README.txt.in101
1 files changed, 57 insertions, 44 deletions
diff --git a/README.txt.in b/README.txt.in
index 65b9f7e..d512fa7 100644
--- a/README.txt.in
+++ b/README.txt.in
@@ -4,19 +4,21 @@ 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, SPARC, Intel, RISCV,
-MIPS, NIOS-II, Microblaze and more.
+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 directory contains the source code for the RTEMS @VERSION@ operating
-system and tools. Please refer to the RTEMS Developers Wiki for the release
-notes.
+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 (users@rtems.org) and let us know how you
-are using RTEMS. We love hearing about user's projects.
+The release note are contained in rtems-@RELEASE@-release-notes.pdf.
+
+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.
@@ -27,7 +29,7 @@ RTEMS Web Sites
~~~~~~~~~~~~~~~
Home: https://www.rtems.org/
-Developers: https://devel.rtems.org/
+ Wiki: https://devel.rtems.org/
Docs: https://docs.rtems.org/
Bug: https://devel.rtems.org/query
Lists: https://lists.rtems.org/
@@ -36,19 +38,21 @@ Developers: https://devel.rtems.org/
Release Files
~~~~~~~~~~~~~
- - README.txt This document.
- - contrib Directory contains extra release related files.
- - rtems-@RELEASE@-release-notes.pdf The RTEMS Release notes.
- - 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.
- - rtems-docs-@RELEASE@.tar.xz The RTEMS Documentation source.
- - rtems-libbsd-@RELEASE@.tar.xz The RTEMS LibBSD source.
- - rtems-doxygen-@RELEASE@.tar.xz The RTEMS CPU Kit doxygen documentation.
- - rtems-examples-v2-@RELEASE@.tar.xz The RTEMS Examples source.
- - sha512sum.txt The SHA512 checksums for this directory.
- - docs The generated RTEMS documentation.
- - sources The source code the tools for this release.
+@TABLE-START@
+ - README.txt | This document.
+ - contrib | Directory contains extra release related files.
+ - docs: | The generated RTEMS documentation.
+ - RTEMS Documentation | See below.
+ - sources: | The source code for this release.
+ - 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.
+ - rtems-docs-@RELEASE@.tar.xz | The RTEMS Documentation source.
+ - rtems-libbsd-@RELEASE@.tar.xz | The RTEMS LibBSD source.
+ - rtems-examples-@RELEASE@.tar.xz | The RTEMS Examples source.
+ - rtems-@RELEASE@-release-notes.pdf | The RTEMS Release notes.
+ - sha512sum.txt | The SHA512 checksums for this directory.
+@TABLE-END@
RTEMS Documentation
~~~~~~~~~~~~~~~~~~~
@@ -77,32 +81,41 @@ The following manuals are available as compress HTML tar files or PDF:
- docs/rtems-docs-@RELEASE@-shell.pdf
- docs/rtems-docs-@RELEASE@-shell-html.tar.xz
+ - RTEMS Doxygen
+ - docs/rtems-docs-@RELEASE@-shell.pdf
+ - docs/rtems-docs-@RELEASE@-shell-html.tar.xz
+
Quick Guide to Building
~~~~~~~~~~~~~~~~~~~~~~~
-To build the tools and kernel for an architecture download:
+For new user rhe Quick Start in the User Manual contains a details Quick Start
+guide. Download the User Manual:
+
+ @RELEASE_URL@/docs/rtems-docs-@RELEASE@-user.pdf
+
+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:
- rtems-source-builder-@RELEASE@.tar.xz
+ cd
+ mkdir -p development/rtems
+ wget @RELEASE_URL@/sources/rtems-source-builder-@RELEASE@.tar.xz
+ tar jxf rtems-source-builder-@RELEASE@.tar.xz
+ cd rtems-source-builder-@RELEASE@/rtems
-Please check to the RSB documentation (https://docs.rtems.org/rsb/) and the
-Wiki (TBD) if you have any issues.
+To build the tools for the ARM architecture:
-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).
+ ../source-builder/sb-set-builder \
+ --prefix=$HOME/development/rtems/@RELEASE@ \
+ @VERSION@/rtems-arm
-The following builds RTEMS for the SPARC architecture:
+To build the tools, kernel and all packages for the Beagleboneblack:
- $ cd
- $ mkdir development/rtems
- $ cd development/rtems
- $ tar Jxf 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
+ ../source-builder/sb-set-builder \
+ --prefix=$HOME/development/rtems/@RELEASE@ \
+ @VERSION@/bsps/beagleboneblack
-To disable building the RTEMS Kernel add to the command line '--without-rtems'.
+If you encounter a problem please post to the user@rtems.org mailing list. You
+can join the Users mailing at https://lists.rtems.org/.
-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.
+If you find a bug please raise a ticket at https://devel.rtems.org/newticket.