Commit c20aa931 authored by Daniel Verkamp's avatar Daniel Verkamp
Browse files

doc: add README.md for Doxygen and online docs



Change-Id: I9af8a77ac1faccf950669f8e61c6ea4d596209c7
Signed-off-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
parent db69cad9
Loading
Loading
Loading
Loading

doc/README.md

0 → 100644
+11 −0
Original line number Diff line number Diff line
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`.