X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=README.md;h=090dd35f9b2310a1c4ba67e2028589faa71bffd6;hb=f2a23cc8602525a325eaeaae6aca5e18882c33da;hp=cf43a4df8a550923f9d72fafadf61bc5f44af4ce;hpb=f304552665ddd0658b361698424b815ff8237ef0;p=vpp.git diff --git a/README.md b/README.md index cf43a4df8a5..090dd35f9b2 100644 --- a/README.md +++ b/README.md @@ -30,23 +30,22 @@ Directory name | Description build-root | Build output directory doxygen | Documentation generator configuration dpdk | DPDK patches and build infrastructure - g2 | Event log visualization tool - perftool | Performance tool -@ref plugins | VPP bundled plugins directory -@ref svm | Shared virtual memory allocation library - test | Unit tests -@ref vlib | VPP application library source -@ref vlib-api | VPP API library source -@ref vnet | VPP networking source -@ref vpp | VPP application source -@ref vpp-api | VPP application API source - vppapigen | VPP API generator source - vpp-api-test | VPP API test program source -@ref vppinfra | VPP core library source - -(If the page you are viewing is not generated by Doxygen then -ignore any @@ref labels in the above table.) - +@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/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 +@ref src/vpp/api | Not-yet-relocated API bindings + test | Unit tests and Python test harness ## Getting started @@ -68,7 +67,7 @@ To install system dependencies, build VPP and then install it, simply run the build script. This should be performed a non-privileged user with `sudo` access from the project base directory: - ./build-root/vagrant/build.sh + ./extras/vagrant/build.sh If you want a more fine-grained approach because you intend to do some development work, the `Makefile` in the root directory of the source tree @@ -80,7 +79,7 @@ interest. To see the available targets run: ### Quick-start: Vagrant -The directory `build-root/vagrant` contains a `VagrantFile` and supporting +The directory `extras/vagrant` contains a `VagrantFile` and supporting scripts to bootstrap a working VPP inside a Vagrant-managed Virtual Machine. This VM can then be used to test concepts with VPP or as a development platform to extend VPP. Some obvious caveats apply when using a VM for VPP @@ -96,7 +95,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 @ref test_framework_doc for details.