From d3ba5e5b26c5c7c60df2aa31704c90997aaac2ad Mon Sep 17 00:00:00 2001 From: Håkan Jonsson Date: Tue, 13 Sep 2016 10:44:32 +0200 Subject: doc: Initial doxygen framework for NSH SFC project MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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: I795dfd921dc3db1bf9fe901fb352edf8a3d65b50 Signed-off-by: Håkan Jonsson --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md (limited to 'README.md') 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.) + + -- cgit