hs-test: fixed timed out tests passing in the CI

[vpp.git] / README.md

diff --git a/README.md b/README.md
index b70103f..0503680 100644 (file)
--- a/README.md
+++ b/README.md
@@ -19,33 +19,32 @@ For more information on VPP and its features please visit the
 ## Changes
 
 Details of the changes leading up to this version of VPP can be found under
-@ref release_notes.
+doc/releasenotes.
 
 
 ## 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
-
+| Directory name         | Description                                 |
+| ---------------------- | ------------------------------------------- |
+| build-data             | Build metadata                              |
+| build-root             | Build output directory                      |
+| docs                   | Sphinx Documentation                        |
+| dpdk                   | DPDK patches and build infrastructure       |
+| extras/libmemif        | Client library for memif                    |
+| src/examples           | VPP example code                            |
+| src/plugins            | VPP bundled plugins directory               |
+| src/svm                | Shared virtual memory allocation library    |
+| src/tests              | Standalone tests (not part of test harness) |
+| src/vat                | VPP API test program                        |
+| src/vlib               | VPP application library                     |
+| src/vlibapi            | VPP API library                             |
+| src/vlibmemory         | VPP Memory management                       |
+| src/vnet               | VPP networking                              |
+| src/vpp                | VPP application                             |
+| src/vpp-api            | VPP application API bindings                |
+| src/vppinfra           | VPP core library                            |
+| src/vpp/api            | Not-yet-relocated API bindings              |
+| test                   | Unit tests and Python test harness          |
 
 ## Getting started
 
@@ -67,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
@@ -79,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
@@ -95,12 +94,8 @@ 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.
-
-
-## Test Framework
+advanced building strategies and other development notes.
 
-There is PyDoc generated documentation available for the VPP test framework. See @subpage test_framework_doc for details.