nat: use correct data types for memory sizes

[vpp.git] / README.md

diff --git a/README.md b/README.md
index 8520b39..4cc283b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -24,29 +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 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
-     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 vpp-api           | Not-yet-relocated API bindings
-
+| 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
 
@@ -68,7 +66,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 +78,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 +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 @ref test_framework_doc for details.