From 2bdf8a2b8167e179b76d4f55ce48ab9758163fb8 Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Fri, 9 Jul 2010 09:25:33 +0200 Subject: [PATCH] add a README file --- README | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..d21d626 --- /dev/null +++ b/README @@ -0,0 +1,18 @@ +gen_ladder - tool to generate protocol ladder diagrams +(C) 2010 by Harald Welte + +This tool can be used to generate typical ladder diagrams as they are often +used in the description of networking protocols. + +The input file is a ".lad" file, from which gen_ladder.pl generates a graphviz +file called ".dot", which in turn can be processed by the "dot" program to +generate a .ps (postscript) or .svg output file. + +As an example, I have included a "test.lad" file, which you can process by +calling + make test.ps +or + make test.svg + +The manual intermediate steps can be seen from the Makefile. +