From c20aa93181e84a606b07c68c657a128cb8b79b84 Mon Sep 17 00:00:00 2001 From: Daniel Verkamp Date: Wed, 28 Sep 2016 14:25:14 -0700 Subject: [PATCH] doc: add README.md for Doxygen and online docs Change-Id: I9af8a77ac1faccf950669f8e61c6ea4d596209c7 Signed-off-by: Daniel Verkamp --- doc/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 doc/README.md diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 000000000..192de7b59 --- /dev/null +++ b/doc/README.md @@ -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`.