aboutsummaryrefslogtreecommitdiffstats
path: root/nsh-plugin/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'nsh-plugin/README.md')
-rw-r--r--nsh-plugin/README.md35
1 files changed, 35 insertions, 0 deletions
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.