README
1
2 Graph-ReadWrite
3
4This is a collection of perl classes for reading and writing
5directed graphs in a variety of file formats. The graphs are
6represented in Perl using Jarkko Hietaniemi's Graph classes.
7Version 2+ of this distribution works with version 0.5 and
8later of the Graph distribution.
9
10There are two base classes:
11
12 Graph::Reader
13 Base class for classes which read a graph
14 file and create an instance of the Graph class.
15
16 Graph::Writer
17 Base class for classes which take an instance of the
18 Graph class and write it out in a specific file format.
19
20This distribution also defines a simple XML format for storing
21directed graphs, defined to meet the needs of the Graph class.
22A reader and writer are provided for this:
23
24 Graph::Reader::XML
25 Graph::Writer::XML
26
27Writers are also included for Dot, VCG, and daVinci,
28two packages for displaying / rendering graphs.
29Dot and VCG are freely available; daVinci is freely available
30at the moment, but that is going to change soon.
31
32 Graph::Writer::Dot
33 Graph::Writer::VCG
34 Graph::Writer::daVinci
35
36A reader for Dot files has been contributed by Mark Hillebrand:
37
38 Graph::Reader::Dot
39
40A reader and writer for HTK lattices are also included:
41
42 Graph::Reader::HTK
43 Graph::Writer::HTK
44
45These last two will probably only be of interest to people working
46with HTK, or tools which use the same format.
47
48Dependencies:
49 Graph Jarkko's Graph classes
50 XML::Parser used by Graph::Reader::XML
51 XML::Writer used by Graph::Writer::XML
52 IO::File
53
54To install these modules, you should just have to run the following:
55
56 % perl Makefile.PL
57 % make
58 % make test
59 % make install
60
61This distribution contains an early version of a test-suite;
62you may get a warning about an undefined value from one of the tests.
63
64Bugs, suggestions, and new readers and writers will be gratefully received.
65
66Neil Bowers <neil@bowers.com>
67