aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorChris Luke <chrisy@flirble.org>2017-09-27 15:09:48 -0400
committerFlorin Coras <florin.coras@gmail.com>2017-09-28 01:47:14 +0000
commitd84f2ef54a457918f21bb0ee82392274b62611fe (patch)
tree9977c9644b6a8c32d4eb19a1328050cfd1d339e5 /README.md
parent7ea28045aabf29f6ed50894fc23f2e7166297614 (diff)
General documentation updates
- We now have several developer-focused docs, so create an index page for them. - Rework several docs to fit into the index structure. - Experiment with code highlighting; tweak the CSS slightly to make it slightly nicer to look at. Change-Id: I4185a18f84fa0764745ca7a3148276064a3155c6 Signed-off-by: Chris Luke <chrisy@flirble.org> (cherry picked from commit 64ebb5ff1338140d94c7f9ee72138fe84d89de2e)
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/README.md b/README.md
index 596494b94f8..090dd35f9b2 100644
--- a/README.md
+++ b/README.md
@@ -30,10 +30,11 @@ Directory name | Description
build-root | Build output directory
doxygen | Documentation generator configuration
dpdk | DPDK patches and build infrastructure
-@ref src | VPP source code
+@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 | Unit tests
+ 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
@@ -43,9 +44,8 @@ Directory name | Description
@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
+ test | Unit tests and Python test harness
## Getting started
@@ -95,12 +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 @subpage test_framework_doc for details.
+There is PyDoc generated documentation available for the VPP test framework.
+See @ref test_framework_doc for details.