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 --- nsh-plugin/README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 nsh-plugin/README.md (limited to 'nsh-plugin/README.md') diff --git a/nsh-plugin/README.md b/nsh-plugin/README.md new file mode 100644 index 0000000..82e43cc --- /dev/null +++ b/nsh-plugin/README.md @@ -0,0 +1,35 @@ +NSH plugin for VPP +================== + +## Introduction. + +The NSH plugin for VPP. + +TBW + + +## Directory layout. + +Directory name | Description +---------------------- | ------------------------------------------- + build | Build output directory + java | Java files + nsh | NSH plugin implementation + vpp-api | VPP API files + +(If the page you are viewing is not generated by Doxygen then +ignore any @@ref labels in the above table.) + + +## Getting started. + +TBW + +### Quick-start: On an existing Linux host. + +TBW + +## More information. + +Visit the [NSH SFC project](https://wiki.fd.io/view/NSH_SFC) for details on more +advanced building strategies and development notes. -- cgit