summaryrefslogtreecommitdiffstats
path: root/doc/userguide/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 17:39:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 17:39:49 +0000
commita0aa2307322cd47bbf416810ac0292925e03be87 (patch)
tree37076262a026c4b48c8a0e84f44ff9187556ca35 /doc/userguide/README.md
parentInitial commit. (diff)
downloadsuricata-a0aa2307322cd47bbf416810ac0292925e03be87.tar.xz
suricata-a0aa2307322cd47bbf416810ac0292925e03be87.zip
Adding upstream version 1:7.0.3.upstream/1%7.0.3
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/userguide/README.md')
-rw-r--r--doc/userguide/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/userguide/README.md b/doc/userguide/README.md
new file mode 100644
index 0000000..b625625
--- /dev/null
+++ b/doc/userguide/README.md
@@ -0,0 +1,15 @@
+# Suricata User Guide
+
+This directory contains the Suricata Guide. The Suricata Developer's guide
+is included as a chapter of the Guide.
+The [Sphinx Document Generator](http://sphinx-doc.org) is used to build the
+documentation. For a primer os reStructuredText see the
+[reStructuredText Primer](http://sphinx-doc.org/rest.html).
+
+## Verifying Changes
+
+There are a number of output formats to choose from when making the source documentation locally (e.g. html, pdf, man).
+
+The documentation source can be built with `make -f Makefile.sphinx html`. Substitute the 'html' word for desired output format.
+
+There are different application dependencies based on the output desired.