summaryrefslogtreecommitdiffstats
path: root/README.txt
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2019-10-29 15:27:17 +1100
committerChris Johns <chrisj@rtems.org>2019-10-29 15:27:17 +1100
commitdb2c6837717dd04b314fad745ab5501c4e259be3 (patch)
treec7a80b42646cd35748e11a5c5cec07080b8ffe6a /README.txt
parentUpdate the release note's coverpage year to 2018. (diff)
downloadrtems-release-db2c6837717dd04b314fad745ab5501c4e259be3.tar.bz2
Update to support RTEMS 5
Diffstat (limited to '')
-rw-r--r--README.txt27
-rw-r--r--README.txt.in4
2 files changed, 27 insertions, 4 deletions
diff --git a/README.txt b/README.txt
index dd93fba..a28fe21 100644
--- a/README.txt
+++ b/README.txt
@@ -1,11 +1,34 @@
RTEMS Project Release Scripts.
Chris Johns <chrisj@rtems.org>
-Date: March 2016
+Date: November 2019
These scripts release the RTEMS kernel. They are tested and run on the
RTEMS Project FreeBSD server.
To run:
- $ ./rtems-release 4.11 0-rc1
+ $ ./rtems-release 5 0.0-m1911
+
+Set Up
+------
+
+Releases are made on a FreeBSD machine. These scripts should work on
+any hosts however no testing has been done on other systems.
+
+1. Install git.
+
+2. Crate a python3 vritualenv set up. If python3 is the system default
+ the --python option is not needed:
+
+ $ virtualenv --python=python3 release
+
+3. Install sphinx using pip in the virtualenv:
+
+ $ . ./release/bin/activate
+ (release) $ pip install sphinx
+ (release) $ pip install sphinxcontrib-bibtex
+
+4. Install npm and the install the HTML inliner:
+
+ # npm install inliner
diff --git a/README.txt.in b/README.txt.in
index d9c127e..65b9f7e 100644
--- a/README.txt.in
+++ b/README.txt.in
@@ -8,8 +8,8 @@ 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, Blackfin,
-MIPS, Microblaze and more.
+processor architectures including ARM, PowerPC, SPARC, Intel, RISCV,
+MIPS, NIOS-II, 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