summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorChris Luke <chrisy@flirble.org>2016-09-14 12:42:54 -0400
committerDamjan Marion <dmarion.lists@gmail.com>2016-09-20 10:53:04 +0000
commit5ccbaa97a86715bfee2ab44523075a93a8abb698 (patch)
treeed6b0b9dd2a65e5fc557cd4f07623da2e41bb7b7 /README.md
parenta8cd30937e5dc8a3bf629e1ee667550e267e5651 (diff)
Add structure to some of the documentation; VPP-223
Moves the random .md files, when rendered by Doxygen, into a config examples tree. We may later flesh this out into a more complete user documentation section. Change-Id: If423b82f1047f1c84f90876a786313054b5f7c77 Signed-off-by: Chris Luke <chrisy@flirble.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.md b/README.md
index ccc832c45d5..bf26c9debc6 100644
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@ Directory name | Description
g2 | Event log visualization tool
gmod | perf related?
perftool | Performance tool
- plugins | VPP bundled plugins directory
+@ref plugins | VPP bundled plugins directory
@ref svm | Shared virtual memory allocation library
test | Unit tests
@ref vlib | VPP application library source
@@ -90,5 +90,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.
+
Visit the [VPP wiki](https://wiki.fd.io/view/VPP) for details on more
advanced building strategies and development notes.