Add a changelog
[pgp-tools.git] / springgraph / README.springgraph
1 springgraph
2 -----------
3
4 Springgraph will read in a .dot file description of a graph, which,
5 for each node, specifies its name and which other nodes it is
6 connected to, and then renders a graph. Each node is drawn as an
7 ellipse, and each connection is drawn as an arrow. The node placement
8 is a result of all of the nodes moving away from each other, while
9 all nodes which are connected move toward each other. This movement
10 is repeated until it stabilizes.
11
12 Springgraph was written as an alternative to neato, which is part of
13 graphviz. It attempts to read the same .dot files used by graphviz,
14 but currently only supports a limited number of node attributes
15 (label and fillcolor).
16
17 Definition of the .dot files which springgraph renders can be found
18 in the graphviz man pages. A copy is here:
19 * http://www.graphviz.org/Documentation.php
20 * http://www.graphviz.org/cvs/doc/info/lang.html
21
22 Springgraph only supports the fillcolor and label node attributes, and can only
23 handle two nodes per edge definition ("node1 -> node2", not "node1 -> node2 ->
24 node3").
25
26 -- Christoph Berg <cb@df7cb.de> Sun, 6 Mar 2005 17:44:47 +0100