xref: /spdk/doc/README.md (revision 1e1fd9ac219da3e52bc166c9d2bb2376c62c113d)
1*1e1fd9acSwawryk# SPDK Documentation
2c20aa931SDaniel Verkamp
3c20aa931SDaniel VerkampThe current version of the SPDK documentation can be found online at
4a3658ab0SDaniel Verkamphttp://www.spdk.io/doc/
5c20aa931SDaniel Verkamp
6*1e1fd9acSwawryk## Building the Documentation
7c20aa931SDaniel Verkamp
83710fdddSStephen BatesTo convert the documentation into HTML run `make` in the `doc`
93710fdddSStephen Batesdirectory.  The output will be located in `doc/output/html`. Before
103710fdddSStephen Batesrunning `make` ensure all pre-requisites are installed.  See
113710fdddSStephen Bates[Installing Prerequisites](http://www.spdk.io/doc/getting_started.html)
123710fdddSStephen Batesfor more details.
13