summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2018-04-10 16:28:58 +1000
committerChris Johns <chrisj@rtems.org>2018-04-11 11:49:03 +1000
commit343f208409484c3923b3f7a5cf40ebdefbbed29e (patch)
treec70f6c8ea4b15aafe85e8e619629e90b6998e81a /README
parent2eaea4223f9d60a2d83630b9c60fbf79323105fb (diff)
downloadrtems-343f208409484c3923b3f7a5cf40ebdefbbed29e.tar.bz2
Updated README.
Diffstat (limited to 'README')
-rw-r--r--README67
1 files changed, 50 insertions, 17 deletions
diff --git a/README b/README
index 88a4999f20..972797366d 100644
--- a/README
+++ b/README
@@ -1,24 +1,57 @@
-This is the Real-Time Executive for Multiprocessing Systems (RTEMS).
-The version number for this software is indicated in the VERSION file.
+Real-Time Executive for Multiprocessing Systems (RTEMS)
+-------------------------------------------------------
+
+RTEMS, Real-Time Executive for Multiprocessor Systems, is a real-time executive
+(kernel) which provides a high performance environment for embedded
+applications with the following features:
+
+ - standards based user interfaces
+ - multitasking capabilities
+ - homogeneous and heterogeneous multiprocessor systems
+ - event-driven, priority-based, preemptive scheduling
+ - optional rate monotonic scheduling
+ - intertask communication and synchronization
+ - priority inheritance
+ - responsive interrupt management
+ - dynamic memory allocation
+ - high level of user configurability
+ - open source with a friendly user license
+
+Project git repositories are located at https://git.rtems.org/
+
+ RTEMS Kernel: https : https://git.rtems.org/rtems/
+ RTEMS Source Builder : https://git.rtems.org/rtems-source-builder/
+ RTEMS Tools : https://git.rtems.org/rtems-tools/
+ RTEMS Documentation : https://git.rtems.org/rtems-docs/
+ RTEMS FreeBSD : https://git.rtems.org/rtems-libbsd/
+
+Online documentation is available at https://docs.rtems.org/
-See the documentation manuals in doc/ with daily builds available online at
-http://rtems.org/onlinedocs/doc-current/share/rtems/html/ and released builds
-at http://www.rtems.org/onlinedocs/releases/ for information on building,
-installing, and using RTEMS. The INSTALL file tells you to come back here.
+ RTEMS User Manual : https://docs.rtems.org/branches/master/user/index.html
+ RTEMS RSB Manual : https://docs.rtems.org/branches/master/rsb/index.html
+ RTEMS Classic API : https://docs.rtems.org/branches/master/c-user/index.html
+ RTEMS POSIX API : https://docs.rtems.org/branches/master/posix-users/index.html
-See the RTEMS Wiki at http://devel.rtems.org for community knowledge and
-tutorials.
+RTEMS Doxygen for CPUKit : https://docs.rtems.org/doxygen/branches/master/
-RTEMS Doxygen available at http://www.rtems.org/onlinedocs/doxygen/cpukit/html
+RTEMS POSIX 1003.1 Compliance Guide :
+ https://docs.rtems.org/branches/master/posix-compliance/index.html
-The RTEMS Project maintains mailing lists which are used for most
-discussions:
+ - Details the standards base functionality and profiles RTEMS supportsXo
-* For general-purpose questions related to using RTEMS, use the
- rtems-users ml: https://lists.rtems.org/mailman/listinfo/users
-* For questions and discussion related to development of RTEMS, use the
- rtems-devel ml: https://lists.rtems.org/mailman/listinfo/devel
+RTEMS Developers Wiki : http://devel.rtems.org
-See https://devel.rtems.org/ to view existing or file a new issue
-report ticket.
+ - Bug reporting, community knowledge and tutorials.
+RTEMS Mailing Lists : https://lists.rtems.org/mailman/listinfo
+
+ - The RTEMS Project maintains mailing lists which are used for most
+ discussions:
+
+ * For general-purpose questions related to using RTEMS, use the rtems-users
+ ml: https://lists.rtems.org/mailman/listinfo/users
+
+ * For questions and discussion related to development of RTEMS, use the
+ rtems-devel ml: https://lists.rtems.org/mailman/listinfo/devel
+
+The version number for this software is indicated in the VERSION file.