Rewrap README.md and add link to mailing list.
[processor-sdk/open-amp.git] / README.md
index 4503122894dfabc70082ccc6b8376e94bb3781ab..8497c0b99913c4f9c61a07bd556bd277314762f3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,18 +1,31 @@
 open-amp
 ========
 open-amp
 ========
-This repository is a place holder for Open Asymmetric Multi Processing (OpenAMP) framework project. The OpenAMP framework provides software components that enable development of software applications for Asymmetric Multiprocessing (AMP) systems. OpenAMP provides following features:
+This repository is the home for the Open Asymmetric Multi Processing (OpenAMP)
+framework project. The OpenAMP framework provides software components that
+enable development of software applications for Asymmetric Multiprocessing
+(AMP) systems. The framework provides the following key capabilities.
 
 
-1. Fully functional remoteproc and rpmsg components usable in following configurations;
-       a. Linux master/Nucleus RTOS or Bare Metal remote configuration
-       b. Nucleus master/Nucleus RTOS or Bare Metal remote configuration
-       c. Nucleus RTOS or Bare Metal master/Linux remote configuration
-2. Proxy infrastructure and supplied demos showcase ability of proxy on master to handle printf, scanf, open, close, read, write calls from Nucleus RTOS and Bare metal based remote contexts.
-3. Documentation - OpenAMP User Manual, OpenAMP Getting Started Guide and Performance Test Measurements.
-4. Performance tests have been conducted and OpenAMP latency measurements have been quantified and documented.
+1. Provides Life Cycle Management, and Inter Processor Communication
+   capabilities for management of remote compute resources and their associated
+   software contexts
+2. Provides a stand alone library usable with RTOS and Baremetal software
+   environments
+3. Compatibility with upstream Linux remoteproc and rpmsg components
+4. Following AMP configurations supported
+       a. Linux master/Baremetal remote
+       b. Baremetal master/Linux remote
+5. Proxy infrastructure and supplied demos showcase ability of proxy on master
+   to handle printf, scanf, open, close, read, write calls from Bare metal
+   based remote contexts.
 
 Following are the known limitations:
 
 
 Following are the known limitations:
 
-1. In rpc_demo.c(the remote demonstration application that showcases usage of rpmsg retargetting infrastructure),  the bindings for the flag input parameter in open() system call has been redefined. The GCC tool library bindings for this input argument is different between arm-xilinx/none-eabi, and arm-linux-eabi toolchains. For this reason, redefinition is required for compatibility with proxy on Linux master.
-
+1. In rpc_demo.c(the remote demonstration application that showcases usage of
+   rpmsg retargetting infrastructure),  the bindings for the flag input
+   parameter in open() system call has been redefined. The GCC tool library
+   bindings for this input argument is different between arm-xilinx/none-eabi, and
+   arm-linux-eabi toolchains. For this reason, redefinition is required for
+   compatibility with proxy on Linux master.
 
 For using the framework please refer to the documents present in the /docs folder.
 
 For using the framework please refer to the documents present in the /docs folder.
+Subscribe to the open-amp mailing list at https://groups.google.com/group/open-amp.