summaryrefslogtreecommitdiffstats
path: root/src/spdk/doc/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 18:24:20 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 18:24:20 +0000
commit483eb2f56657e8e7f419ab1a4fab8dce9ade8609 (patch)
treee5d88d25d870d5dedacb6bbdbe2a966086a0a5cf /src/spdk/doc/README.md
parentInitial commit. (diff)
downloadceph-483eb2f56657e8e7f419ab1a4fab8dce9ade8609.tar.xz
ceph-483eb2f56657e8e7f419ab1a4fab8dce9ade8609.zip
Adding upstream version 14.2.21.upstream/14.2.21upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/spdk/doc/README.md')
-rw-r--r--src/spdk/doc/README.md14
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 00000000..c5c03b28
--- /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.