README

   1 LuaGRAPH
   2 ========
   3
   4
   5 * LuaGRAPH
   6   --------
   7
   8   LuaGRAPH is a binding to the graphviz library.
   9
  10   LuaGRAPH requires the graphviz library version 2.26 or later, which
  11   can be downloaded from
  12
  13         http://www.graphviz.org/
  14
  15
  16   You must have Lua version 5.1, 5.2 or 5.3. Lua can be downloaded
  17   from its home page:
  18           http://www.tecgraf.puc-rio.br/lua/
  19
  20
  21 * Documentation
  22   -------------
  23
  24   Documentation of LuaGRAPH comes with the LuaGRAPH distribution. I recommend also to
  25   read the graphviz documentation, which can be found here:
  26
  27         http://www.graphviz.org/Documentation.php
  28
  29
  30 * Legal matters
  31   -------------
  32
  33   See the license agreement in the file LICENSE.
  34
  35 * Download
  36   --------
  37   LuaGRAPH can be downloaded from github at
  38
  39         https://github.com/hleuwer/luagraph
  40
  41   or install with luarocks. See below under "Installation".
  42
  43 * Configuration
  44   -------------
  45
  46   Before building LuaGRAPH you have to adopt the config file by
  47   adjusting various constants to the installed Lua and Graphviz version.
  48
  49 * Status
  50   ------
  51   Newest version is LuaGRAPH 2.0 now supports the `cgraph´ library and all
  52   Lua versions from Lua 5.1 to Lua 5.3. Lua 5.0 is no longer supported.
  53   It has been tested on MacOS Sierra version 10.12.13, Linux Debian and
  54   Windows 10 running as guest in a Virtual Box virtual machine under MacOS.
  55
  56   Under Windows luarocks has only been tested with Lua 5.1 using the
  57   LuaForWindows installation.
  58
  59 * Installation
  60   ------------
  61
  62   Install via Luarocks (MacOS and Linux only)
  63   - - - - - - - - - - - - - - - - - - - - - -
  64   Simply type the following:
  65
  66      $ sudo luarocks GRAPHVIZ_DIR=/opt/local install luagraph
  67
  68   You may have to change the value for the GRAPHVIZ_DIR variable to ensure
  69   that luarocks finds your GRAPHVIZ installation. On MacOS it is typically
  70   installed in /opt/local.
  71
  72   Manual Installation under MacOS or Linux
  73   - - - - - - - - - - - - - - - - - - - - -
  74   In order to build LuaGRAPH on a Linux, MacOS or Cygwin/Mingw based
  75   POSIX like system:
  76
  77   1. Make sure you have Lua 5.1 to 5.3.
  78      The file test.lua in the test subdirectory uses lualogging which
  79      can be installed via Luarocks at http://www.luarocks.org.
  80
  81   2. With graphviz version 2.12 you might have to use the `ltdl' library
  82      that comes with graphviz in order to have the rendering plugins to
  83      work properly. Version 2.40 is currently the last graphviz version
  84      that is supported.
  85
  86   3. LuaGRAPH comes with a makefile and a simple config file to adopt
  87      the make process to your target system.
  88
  89   4. Adopt build configuration to your platform by editing the file
  90      config according to you needs.
  91
  92   5. Compile the package
  93
  94      Type
  95         make
  96
  97      If make succeeds you get:
  98
  99      * a Lua extension library "graph.so.x.0" in the src sub-directory.
 100      * a copy "core.so" of the same Lua extension library in ./graph
 101
 102   6. Type "make install" as user root in order to install all relevant
 103      files in standard places. The directory /usr/local is the default
 104      install prefix.
 105
 106   Manual Build and Installation under Windows
 107   - - - - - - - - - - - - - - - - - - - - - -
 108   In order to build LuaGRAPH on Windows, use the Visual Studio 2008
 109   project file that comes with source code. Load the project and build
 110   a Release version inside the Visual Sudio IDE. To make the luagraph
 111   module available copy the file Release/luagraph-2.0.0-2.dll into
 112   graph/core.dll. Sorry for this inconvenience, which I may remove
 113   once I have a really large amount of time.
 114
 115 * Environment Variables
 116   ---------------------
 117
 118   None.
 119
 120
 121 * Comments and bug reports
 122   ------------------------
 123
 124   Please send your comments and bug reports to the Lua mailing list.
 125
 126 December 2006 (January 2017)
 127
 128 Have fun.
 129