diff options
Diffstat (limited to 'src/spdk/doc/README.md')
| -rw-r--r-- | src/spdk/doc/README.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/src/spdk/doc/README.md b/src/spdk/doc/README.md new file mode 100644 index 000000000..c5c03b287 --- /dev/null +++ b/src/spdk/doc/README.md @@ -0,0 +1,14 @@ +SPDK Documentation +================== + +The current version of the SPDK documentation can be found online at +http://www.spdk.io/doc/ + +Building the Documentation +========================== + +To convert the documentation into HTML run `make` in the `doc` +directory. The output will be located in `doc/output/html`. Before +running `make` ensure all pre-requisites are installed. See +[Installing Prerequisites](http://www.spdk.io/doc/getting_started.html) +for more details. |