diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 32 |
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.) + + |