numam-spdk/doc/README.md
wawryk 1e1fd9ac21 markdownlint: enable rule MD025
MD025 - Multiple top level headers in the same document
Fixed all errors
Update check_format.sh to fit new header style in jsonrpc.md

Signed-off-by: Maciej Wawryk <maciejx.wawryk@intel.com>
Change-Id: Ib5f832c549880771c99c15b89affe1e82acd3fa4
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9045
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
2021-08-26 19:27:22 +00:00

13 lines
429 B
Markdown

# 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.