diff mbox

refine README file

Message ID 1397827143-24176-1-git-send-email-maxim.uvarov@linaro.org
State Superseded
Headers show

Commit Message

Maxim Uvarov April 18, 2014, 1:19 p.m. UTC 
Put some useful information to README file.

Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
---
 README | 39 ++++++++++++++++++++++++++++++++-------
 1 file changed, 32 insertions(+), 7 deletions(-)

Comments

Bill Fischofer April 18, 2014, 1:29 p.m. UTC | #1 
Looks good.  But please change for grammar:


On Fri, Apr 18, 2014 at 8:19 AM, Maxim Uvarov <maxim.uvarov@linaro.org>wrote:
>
> +Mailing list:
> +    lng-odp@lists.linaro.org
> +       Please read CONTRIBUTING file before patches submitting.
> -
>

Should be Please read CONTRIBUTING file before submitting patches.
diff mbox

Patch

diff --git a/README b/README
index a6cd4b0..f9b8ce8 100644
--- a/README
+++ b/README
@@ -1,9 +1,34 @@ 
-Added initial ODP files
+Copyright (c) 2013-2014, Linaro Limited
+All rights reserved.
 
-Directory arch/linux-generic contains ODP headers and implementation
-for linux-generic target. Use 'make libs' to build ODP library and
-'make docs' to build ODP API documentation.
+SPDX-License-Identifier:        BSD-3-Clause
 
-Directory test contains simple test application to test few API calls.
-Use 'make' to build the test app, or 'make libs' or 'make docs' to build
-ODP libs and docs, respectively.
+
+OpenDataPlane (ODP) project source code.
+    http://www.opendataplane.org/
+
+Main git repository:
+    git://git.linaro.org/lng/odp.git
+
+    Directory platform/linux-generic contains ODP headers and implementation
+    for linux-generic target.
+    Directory test contains test applications for ODP API calls and features support.
+
+    Use 'make' to build ODP library and samples and 'make docs' to build ODP API
+    documentation. 'make install' will copy all required headers and binary files to
+    build directory.
+    For cross compiling set up appropriate CC:
+        make CC=armeb-linux-gnueabihf-gcc
+
+ODP patches for 3-rd party applications:
+    git://git.linaro.org/lng/odp-apps.git
+
+ODP architecture git tree:
+    git://git.linaro.org/lng/odp-architecture.git
+
+Patches tracking system:
+    https://patches.linaro.org/patchwork/project/lng-odp/list/
+
+Mailing list:
+    lng-odp@lists.linaro.org
+	Please read CONTRIBUTING file before patches submitting.