diff mbox

README: Reorganised into platform specific

Message ID 1406234299-25602-1-git-send-email-anders.roxell@linaro.org
State Superseded
Headers show

Commit Message

Anders Roxell July 24, 2014, 8:38 p.m. UTC
Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
---
 README                        |  8 +++-----
 platform/linux-generic/README | 17 +++++++++++++++++
 2 files changed, 20 insertions(+), 5 deletions(-)
 create mode 100644 platform/linux-generic/README

Comments

Maxim Uvarov July 29, 2014, 9:34 a.m. UTC | #1
Applied!
Maxim.
On 07/25/2014 12:38 AM, Anders Roxell wrote:
> Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
> ---
>   README                        |  8 +++-----
>   platform/linux-generic/README | 17 +++++++++++++++++
>   2 files changed, 20 insertions(+), 5 deletions(-)
>   create mode 100644 platform/linux-generic/README
>
> diff --git a/README b/README
> index 747d484..8c559a0 100644
> --- a/README
> +++ b/README
> @@ -10,19 +10,17 @@ OpenDataPlane (ODP) project source code.
>   Main git repository:
>       git://git.linaro.org/lng/odp.git
>   
> -    Directory platform/linux-generic contains ODP headers and implementation
> -    for linux-generic target.
> +    How to build:
> +    Look in platform/linux-*/README for more detail how to build.
>       Directory test contains test applications for ODP API calls and features support.
>   
> -    How to build:
>       For a list of build dependencies, read DEPENDENCIES.
> +    In general you can build:
>       ./bootstrap
>       ./configure
>       Use 'make' to build ODP library and samples and 'make doxygen-run' to build
>       ODP API documentation. 'make install' will copy all required headers and
>       binary files to the install directory.
> -    The platform sub directories contain README files with platform specific
> -    build details.
>   
>       Configure options:
>           ./configure --help
> diff --git a/platform/linux-generic/README b/platform/linux-generic/README
> new file mode 100644
> index 0000000..3e05dab
> --- /dev/null
> +++ b/platform/linux-generic/README
> @@ -0,0 +1,17 @@
> +Copyright (c) 2014, Linaro Limited
> +All rights reserved.
> +
> +SPDX-License-Identifier:        BSD-3-Clause
> +
> +1. Intro
> +
> +OpenDataPlane implementation for Linux generic. Directory linux-generic contains ODP headers and implementation
> +for linux-generic target. This drop does not target high
> +performance. It is rather proof of ODP API functionality. It still uses
> +linux-generic's SW scheduler.
> +
> +2. Build
> +# To compile ODP
> +./bootstrap
> +./configure
> +make
diff mbox

Patch

diff --git a/README b/README
index 747d484..8c559a0 100644
--- a/README
+++ b/README
@@ -10,19 +10,17 @@  OpenDataPlane (ODP) project source code.
 Main git repository:
     git://git.linaro.org/lng/odp.git
 
-    Directory platform/linux-generic contains ODP headers and implementation
-    for linux-generic target.
+    How to build:
+    Look in platform/linux-*/README for more detail how to build.
     Directory test contains test applications for ODP API calls and features support.
 
-    How to build:
     For a list of build dependencies, read DEPENDENCIES.
+    In general you can build:
     ./bootstrap
     ./configure
     Use 'make' to build ODP library and samples and 'make doxygen-run' to build
     ODP API documentation. 'make install' will copy all required headers and
     binary files to the install directory.
-    The platform sub directories contain README files with platform specific
-    build details.
 
     Configure options:
         ./configure --help
diff --git a/platform/linux-generic/README b/platform/linux-generic/README
new file mode 100644
index 0000000..3e05dab
--- /dev/null
+++ b/platform/linux-generic/README
@@ -0,0 +1,17 @@ 
+Copyright (c) 2014, Linaro Limited
+All rights reserved.
+
+SPDX-License-Identifier:        BSD-3-Clause
+
+1. Intro
+
+OpenDataPlane implementation for Linux generic. Directory linux-generic contains ODP headers and implementation
+for linux-generic target. This drop does not target high
+performance. It is rather proof of ODP API functionality. It still uses
+linux-generic's SW scheduler.
+
+2. Build
+# To compile ODP
+./bootstrap
+./configure
+make