aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorHåkan Jonsson <hakan.jonsson@ericsson.com>2016-09-13 10:44:32 +0200
committerEd Warnicke <hagbard@gmail.com>2016-10-04 22:18:17 +0000
commit440cde6899d2113c07d192b3490b546d8a62a5b9 (patch)
tree510c9f1746e20815f0e16fcd3e947e71484e076b /README.md
parent45fec8fd68f6b65784670fe079f1c0a8d332b405 (diff)
doc: Initial doxygen framework for NSH SFC project
A first attempt for a documentation generation using Doxygen for the NSH SFC project. Doxygen tagging and documentation in the code still need to be done. Based on a copy of the Doxygen framework in VPP. Top Makefile added to (only) build documentation. Change-Id: Ibd09d9f5338609a7f57a384ded86fca874f4efdc Signed-off-by: Håkan Jonsson <hakan.jonsson@ericsson.com> Signed-off-by: Ed Warnicke <eaw@cisco.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9595b06
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+NSH SFC project
+===============
+
+## Introduction.
+
+The FD.io NSH SFC project aims to add the mechanisms to VPP to provide NSH
+based packet forwarding and to support service chaining applications (service
+functions) in a highly efficient fashion.
+
+The NSH plugin for VPP is one of the deliverables from the project.
+
+For more information on NSH SFC project and its features please visit the
+[FD.io website](http://fd.io/) and
+[NSH SFC Project](https://wiki.fd.io/view/NSH_SFC) pages.
+
+
+## Directory layout.
+
+Directory name | Description
+---------------------- | -------------------------------------------
+ build-root | Build output directory
+ doxygen | Documentation generator configuration
+@ref nsh-plugin | Network Service Header plugin
+ nsh-plugin-api | NSH plugin API
+ scripts | Scripts
+ vagrant | Vagrant scripts
+
+
+(If the page you are viewing is not generated by Doxygen then
+ignore any @@ref labels in the above table.)
+
+