d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: add README.md for Doxygen and online docs

Browse Source 
Change-Id: I9af8a77ac1faccf950669f8e61c6ea4d596209c7
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
This commit is contained in:
Daniel Verkamp 2016-09-28 14:25:14 -07:00
parent db69cad95c
commit c20aa93181
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/README.md Normal file
View File

@ -0,0 +1,11 @@
SPDK Documentation
==================
The current version of the SPDK documentation can be found online at
http://www.spdk.io/spdk/doc/
Building the Documentation
==========================
To convert the documentation into HTML, install Doxygen and mscgen and run `make` in the `doc`
directory. The output will be located in `doc/output/html`.