diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 65 |
1 files changed, 36 insertions, 29 deletions
@@ -1,48 +1,55 @@ -Copyright (c) 2013-2014, Linaro Limited -All rights reserved. +SPDX-License-Identifier: BSD-3-Clause +Copyright (c) 2013-2019 Linaro Limited +Copyright (c) 2019-2023 OpenFastPath Foundation -SPDX-License-Identifier: BSD-3-Clause +OpenDataPlane (ODP) project web page: + https://www.opendataplane.org -OpenDataPlane (ODP) project source code. - http://www.opendataplane.org/ +ODP project in GitHub: + https://github.com/OpenDataPlane Main git repository: - git://git.linaro.org/lng/odp.git + https://github.com/OpenDataPlane/odp.git - 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: + See DEPENDENCIES file about system requirements and dependencies to external + libraries/packages. It contains also some more detailed build instructions. - 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-doc' to build - ODP API documentation. 'make install' will copy all required headers and - binary files to the install directory. + Generally, ODP and test applications are built with these three steps: + ./bootstrap + ./configure + make - Configure options: + See help on configure options: ./configure --help - To execute all the testcases, assuming CUnit is installed for the validation tests: - ./bootstrap - ./configure --enable-test-perf --enable-test-vald + ODP header files and libraries can be installed with: + make install + + ODP API documentation can be built with (requires Doxygen): + make doxygen-doc + + Validation tests (requires CUnit) and other test applications can be + executed with: make check - To generate the users guides: + Users guides can be generated with: ./bootstrap - ./configure --enable-user-guide + ./configure --enable-user-guides make -Patches tracking system: - http://patches.opendataplane.org/project/lng-odp/list/ +Licensing: + The default license for ODP project is BSD-3-Clause (see LICENSE file). + SPDX short-form identifiers (https://spdx.dev/ids/) are used in project + source files to identify the used license. The SPDX license list can be + found from https://spdx.org/licenses/. Mailing list: - lng-odp@lists.linaro.org + odp@lists.opendataplane.org - Please read CONTRIBUTING file before submitting patches. - Email prefixes: - [PATCH] means patch is for odp.git +Contributing: + Please read CONTRIBUTING file before submitting patches. ODP project follows + Linux kernel coding style. Bug tracking: - https://bugs.linaro.org/describecomponents.cgi?product=OpenDataPlane%20-%20linux-%20generic%20reference + https://github.com/OpenDataPlane/odp/issues |