X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=README.md;h=596494b94f8ac7123e69c273076266fbe154c6ec;hb=89111d0403c462e6a98e2452d4caa540da1c8587;hp=8520b395f8566f2bf0a0ee58d04ffd4273cf239a;hpb=fdc62abdc113ea63dc867375bd49ef3043dcd290;p=vpp.git diff --git a/README.md b/README.md index 8520b395f85..596494b94f8 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,6 @@ Directory name | Description build-root | Build output directory doxygen | Documentation generator configuration dpdk | DPDK patches and build infrastructure -@ref plugins | Not-yet-relocated VPP bundled plugins directory @ref src | VPP source code @ref src/plugins | VPP bundled plugins directory @ref src/svm | Shared virtual memory allocation library @@ -45,8 +44,8 @@ Directory name | Description @ref src/vpp-api | VPP application API bindings @ref src/vppinfra | VPP core library test | Unit tests -@ref vpp-api | Not-yet-relocated API bindings - +@ref src/vpp/api | Not-yet-relocated API bindings +@ref src/examples | VPP example code ## 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 @@ -100,3 +99,8 @@ information. Visit the [VPP wiki](https://wiki.fd.io/view/VPP) for details on more advanced building strategies and development notes. + + +## Test Framework + +There is PyDoc generated documentation available for the VPP test framework. See @subpage test_framework_doc for details.