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, 5.3 or 5.4. 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.2.0 now supports the `cgraph´ library and all
  47   Lua versions from Lua 5.1 to Lua 5.4. Lua 5.0 is no longer supported.
  48   It has been tested on MacOS Sonoma, Linux Debian and
  49   Windows 10.
  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=<path-to-graphviz-installation> install luagraph
  62
  63 **Manual Installation under MacOS or Linux**
  64
  65   In order to build LuaGRAPH on a Linux, MacOS or Cygwin/Mingw based
  66   POSIX like system:
  67
  68   1. Make sure you have Lua 5.1 to 5.3.
  69      The file test.lua in the test subdirectory uses lualogging which
  70      can be installed via Luarocks at http://www.luarocks.org.
  71
  72   2. With graphviz version 2.12 you might have to use the `ltdl' library
  73      that comes with graphviz in order to have the rendering plugins to
  74      work properly. Version 2.40 is currently the last graphviz version
  75      that is supported.
  76
  77   3. LuaGRAPH comes with a makefile and a simple config file to adopt
  78      the make process to your target system.
  79
  80   4. Adopt build configuration to your platform by editing the file
  81      config according to you needs.
  82
  83   5. Compile the package
  84
  85      Type
  86         make
  87
  88      If make succeeds you get:
  89
  90      * a Lua extension library "graph.so.x.0" in the src sub-directory.
  91      * a copy "core.so" of the same Lua extension library in ./graph
  92
  93   6. Type "make install" as user root in order to install all relevant
  94      files in standard places. The directory /usr/local is the default
  95      install prefix.
  96
  97 **Manual Build and Installation under Windows**
  98
  99   In order to build LuaGRAPH on Windows, use the Visual Studio 2008
 100   project file that comes with source code. Load the project and build
 101   a Release version inside the Visual Sudio IDE. To make the luagraph
 102   module available copy the file Release/luagraph-2.0.0-2.dll into
 103   graph/core.dll. Sorry for this inconvenience, which I may remove
 104   once I have a really large amount of time.
 105
 106 Environment Variables
 107 ---------------------
 108
 109   None.
 110
 111
 112 Comments and bug reports
 113 ------------------------
 114
 115   Please send your comments and bug reports to the Lua mailing list.
 116
 117 ***December 2006 (April 2024)***
 118
 119 ***Have fun!***