diff options
author | Chris Johns <chrisj@rtems.org> | 2020-05-01 18:38:41 +1000 |
---|---|---|
committer | Chris Johns <chrisj@rtems.org> | 2020-05-02 12:38:46 +1000 |
commit | e1b89b0a374d91b3a60c08895e743ae060da0fe5 (patch) | |
tree | d3cfb86dea2ece2648c3b4c1f96d18d4e940addc /README.txt.in | |
parent | Add rtems-notes-5.txt (diff) | |
download | rtems-release-e1b89b0a374d91b3a60c08895e743ae060da0fe5.tar.bz2 |
Generate README.txt and index.html from markdown
- Update to support ARCH-BSPS.md from an updated kernel tool
Diffstat (limited to 'README.txt.in')
-rw-r--r-- | README.txt.in | 126 |
1 files changed, 0 insertions, 126 deletions
diff --git a/README.txt.in b/README.txt.in deleted file mode 100644 index 2f95163..0000000 --- a/README.txt.in +++ /dev/null @@ -1,126 +0,0 @@ -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 (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. - -The release note are contained in: - - <@RELEASE_URL@/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. - -Regards -The RTEMS Development Team. - -RTEMS Web Sites ---------------- - - Home : <https://www.rtems.org/> - Download : <https://ftp.rtems.org/pub/rtems/releases> - Wiki : <https://devel.rtems.org/> - Docs : <https://docs.rtems.org/> - Bugs : <https://devel.rtems.org/query> - Lists : <https://lists.rtems.org/> - Developer : <https://devel.rtems.org/> - GIT : <https://git.rtems.org/> - -Release Files -------------- - -@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 -------------------- - -The generated documentation can be found in the `docs` directory. - -The following manuals are available as compress HTML tar files or PDF: - - - RTEMS User Manual - - `docs/rtems-docs-@RELEASE@-user.pdf` - - `docs/rtems-docs-@RELEASE@-user-html.tar.xz` - - - RTEMS C User Manual - - `docs/rtems-docs-@RELEASE@-c-user.pdf` - - `docs/rtems-docs-@RELEASE@-c-user-html.tar.xz` - - - RTEMS POSIX User Manual - - `docs/rtems-docs-@RELEASE@-posix-user.pdf` - - `docs/rtems-docs-@RELEASE@-posix-user-html.tar.xz` - - - RTEMS Networking User Manual - - `docs/rtems-docs-@RELEASE@-networking.pdf` - - `docs/rtems-docs-@RELEASE@-networking-html.tar.xz` - - - RTEMS Shell User Manual - - `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 -~~~~~~~~~~~~~~~~~~~~~~~ - -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: -``` - cd - mkdir -p development/rtems - cd 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 -``` -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 user@rtems.org mailing list. You -can join the Users mailing at https://lists.rtems.org/. - -If you find a bug please raise a ticket at https://devel.rtems.org/newticket. |