Changeset 343f2084 in rtems for README

Timestamp:

04/10/18 06:28:58 (6 years ago)

Author:

Chris Johns <chrisj@…>

Branches:

5, master

Children:

0c2241c

Parents:

2eaea422

git-author:

Chris Johns <chrisj@…> (04/10/18 06:28:58)

git-committer:

Chris Johns <chrisj@…> (04/11/18 01:49:03)

Message:

Updated README.

File:

• README (modified) (1 diff)

README

@@ -1 @@
-This is the Real-Time Executive for Multiprocessing Systems (RTEMS).
+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/
+
+ 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
+
+RTEMS Doxygen for CPUKit : https://docs.rtems.org/doxygen/branches/master/
+
+RTEMS POSIX 1003.1 Compliance Guide :
+ https://docs.rtems.org/branches/master/posix-compliance/index.html
+
+ - Details the standards base functionality and profiles RTEMS supportsXo
+
+RTEMS Developers Wiki : http://devel.rtems.org
+
+ - 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.
-
-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.
-
-See the RTEMS Wiki at http://devel.rtems.org for community knowledge and
-tutorials.
-
-RTEMS Doxygen available at http://www.rtems.org/onlinedocs/doxygen/cpukit/html
-
-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
-
-See https://devel.rtems.org/ to view existing or file a new issue
-report ticket.
-