diff options
Diffstat (limited to 'doc/userguide/README.md')
| -rw-r--r-- | doc/userguide/README.md | 15 |
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. |