LuaGRAPH
=======


* LuaGRAPH
  --------
  
  LuaGRAPH is a binding to the graphviz library.

  LuaGRAPH requires the graphviz library version 2.8 or later, which
  can be downloaded from 
	
	http://www.graphviz.org/

  The module was developed using graphviz version 2.20.

  You must have Lua version 5.0 or later to use it. Lua can be downloaded 
  from its home page:
	  http://www.tecgraf.puc-rio.br/lua/
c
  If you use LuaGRAPH with Lua 5.0 you should have the compat-5.1 package properly
  installed on your system.
  If you use LuaGRAPH with Lua 5.1 you should set the compiler switch COMPAT_H in
  your makefile.


* Documentation
  -------------

  Documentation of LuaGRAPH comes with the LuaGRAPH distribution. I recommend also to
  read the graphviz documentation, which can be found here:

	http://www.graphviz.org/Documentation.php
	

* Legal matters
  -------------

  See the license agreement in the file LICENSE.
  For the graphviz license see the file COPYING.

* Download
  --------
  LuaGRAPH can be downloaded from LuaForge at 
	
	http://luaforge.net

* Installation
  ------------

  In order to build LuaGRAPH on a Linux, Unix or Cygwin/Mingw based
  POSIX like system:

  1. Make sure you have Lua (version 5.0 or 5.1 later). The file test.lua
     in the test subdirectory uses lualogging which can be downloaded 
     from LuaForge at http://luaforge.net.

  2. With graphviz version 2.12 you might have to use the `ltdl' library 
     that comes with graphviz in order to have the rendering plugins to 
     work properly. 

  3. LuaGRAPH comes with a makefile and a simple config file to adopt
     the make process to your target system.

     Compiler Flags:

     COMPAT_H
	Instruct luaGRAPH to use Lua 5.1. This is automatically chosen if
	you choose Lua 5.1 in the config file. 

  4. Adopt build configuration to your platform by typing

     	   configure

     This 

  5. Compile the package

     Type 
	make

     If make succeeds you get:

     * a Lua extension library "graph.so.x.0" in the src sub-directory.
     * a copy "core.so" of the same Lua extension library in ./graph

  6. Type "make install" as user root in order to install all relevant
     files in standard places. The directory /usr/local is the default
     install prefix.

     

* Environment Variables
  ---------------------

  None.


* LuaGRAPH on MS Windows
  ---------------------

  Not yet finished.


* Comments and bug reports
  ------------------------

  Please send your comments and bug reports to the Lua mailing list.

December 2006

Have fun.