summaryrefslogtreecommitdiffstats
path: root/doc/userguide/devguide/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/devguide/README.md
parentInitial commit. (diff)
downloadsuricata-upstream/1%7.0.3.tar.xz
suricata-upstream/1%7.0.3.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/devguide/README.md')
-rw-r--r--doc/userguide/devguide/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/userguide/devguide/README.md b/doc/userguide/devguide/README.md
new file mode 100644
index 0000000..c5d80eb
--- /dev/null
+++ b/doc/userguide/devguide/README.md
@@ -0,0 +1,9 @@
+# Suricata Developer Guide
+
+This directory contains the Suricata Developer's Guide. It is built as part of the Suricata Userguide.
+
+The Sequence Diagrams seen in the Transactions documentation are generated with Mscgen. Mscgen is a small program to parse Message Sequence Charts that can be represented as text and can then converted to image.
+
+If you need to update the diagrams, please edit the ``.msc`` files present in the diagrams directory (extending/app-layer/diagrams). Once those have been changed, in the ``scripts`` directory (in the main Suricata dir) there's a scrip that will generate images for all files: ``generate-images.sh`` (you'll have to install Mscgen for that to work).
+
+More info about Mscgen can be found at: https://www.mcternan.me.uk/mscgen/