Grafizzi

Welcome to Grapfizzi, a PHP wrapper for AT&T GraphViz.

1) Installing Grafizzi

a) Obtain the Grafizzi sources

With Grafizzi being very new, the easiest way to get started is to clone the Git repository.

git clone http://github.com/fgm/grafizzi.git

b) Download the dependencies

Once you have a clone of the Grafizzi repository, you need to install its dependencies, using the Composer package dependency manager. Download Composer following the instructions on http://getcomposer.org/ and then run:

php composer.phar install

c) Check your System Configuration

Now make sure that your local system is properly configured for Grafizzi. To do this, execute:

php app/hello-node.php

You should set a detailed debug execution trace. On a POSIX system, you can get just the results by redirecting stderr to /dev/null:

php app/hello-node.php 2> /dev/null

You should see a very basic GraphViz source:

graph g {
rankdir="TB";
label="Some graph";
}

If you get any warnings or recommendations, or nothing at all, check your PHP error log, and fix these now before moving on.

2) Generating documentation

If your system includes the make command, and GraphViz itself, you can generate a fully indexed source documentation by running:

make docs

This will generate a HTML documentation with internal search engine in the doxygen/ directory. Use it by browsing to doxygen/html/index.html

The documentation and search engine are even usable over file:/// URLs, so you do not need a web server to access it.

Have fun!