README

SPDX-License-Identifier: BSD-3-Clause
Copyright (c) 2013-2019 Linaro Limited
Copyright (c) 2019-2023 OpenFastPath Foundation

OpenDataPlane (ODP) project web page:
    https://www.opendataplane.org

ODP project in GitHub:
    https://github.com/OpenDataPlane

Main git repository:
    https://github.com/OpenDataPlane/odp.git

How to build:
    See DEPENDENCIES file about system requirements and dependencies to external
    libraries/packages. It contains also some more detailed build instructions.

    ODP requires the -fno-strict-aliasing (or equivalent) compiler option. This
    option is enabled by default in ODP.

    Generally, ODP and test applications are built with these three steps:
        ./bootstrap
        ./configure
        make

    See help on configure options:
        ./configure --help

    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

    Users guides can be generated with:
        ./bootstrap
        ./configure --enable-user-guides
        make

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:
    odp@lists.opendataplane.org

Contributing:
    Please read CONTRIBUTING file before submitting patches. ODP project follows
    Linux kernel coding style.

Bug tracking:
    https://github.com/OpenDataPlane/odp/issues