X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=README.md;h=4cc283b5e530fd12246a33599306cb375fdc26ac;hb=61717cc38;hp=596494b94f8ac7123e69c273076266fbe154c6ec;hpb=583dc8d3e23a780c85ebe48ea59f0338aad4df17;p=vpp.git diff --git a/README.md b/README.md index 596494b94f8..4cc283b5e53 100644 --- a/README.md +++ b/README.md @@ -24,28 +24,27 @@ Details of the changes leading up to this version of VPP can be found under ## Directory layout -Directory name | Description ----------------------- | ------------------------------------------- - build-data | Build metadata - build-root | Build output directory - doxygen | Documentation generator configuration - dpdk | DPDK patches and build infrastructure -@ref src | VPP source code -@ref src/plugins | VPP bundled plugins directory -@ref src/svm | Shared virtual memory allocation library - src/tests | Unit tests - src/vat | VPP API test program -@ref src/vlib | VPP application library -@ref src/vlibapi | VPP API library -@ref src/vlibmemory | VPP Memory management -@ref src/vlibsocket | VPP Socket I/O -@ref src/vnet | VPP networking -@ref src/vpp | VPP application -@ref src/vpp-api | VPP application API bindings -@ref src/vppinfra | VPP core library - test | Unit tests -@ref src/vpp/api | Not-yet-relocated API bindings -@ref src/examples | VPP example code +| Directory name | Description | +| ---------------------- | ------------------------------------------- | +| build-data | Build metadata | +| build-root | Build output directory | +| doxygen | Documentation generator configuration | +| dpdk | DPDK patches and build infrastructure | +| @ref extras/libmemif | Client library for memif | +| @ref src/examples | VPP example code | +| @ref src/plugins | VPP bundled plugins directory | +| @ref src/svm | Shared virtual memory allocation library | +| src/tests | Standalone tests (not part of test harness) | +| src/vat | VPP API test program | +| @ref src/vlib | VPP application library | +| @ref src/vlibapi | VPP API library | +| @ref src/vlibmemory | VPP Memory management | +| @ref src/vnet | VPP networking | +| @ref src/vpp | VPP application | +| @ref src/vpp-api | VPP application API bindings | +| @ref src/vppinfra | VPP core library | +| @ref src/vpp/api | Not-yet-relocated API bindings | +| test | Unit tests and Python test harness | ## Getting started @@ -95,12 +94,13 @@ for this can be found [on the Setting up Vagrant wiki page] ## More information Several modules provide documentation, see @subpage user_doc for more -information. +end-user-oriented information. Also see @subpage dev_doc for developer notes. Visit the [VPP wiki](https://wiki.fd.io/view/VPP) for details on more -advanced building strategies and development notes. +advanced building strategies and other development notes. ## Test Framework -There is PyDoc generated documentation available for the VPP test framework. See @subpage test_framework_doc for details. +There is PyDoc generated documentation available for the VPP test framework. +See @ref test_framework_doc for details.