README.md

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