INSTALL.TXT

   1 Installation guidelines
   2 =======================
   3
   4 ======================================================================
   5 TESTING AN INSTALLATION PROCEDURE IS HARD, AND RARELY DONE RIGHT AT
   6 THE FIRST TRY. IF YOU EXPERIENCE INSTALLATION TROUBLES, PLEASE REPORT
   7 THEM, TO AVOID THEM TO FUTURE USERS. mailto:metalua@gmail.com
   8 ======================================================================
   9
  10 Prerequisites
  11 -------------
  12 - under MS-Windows, ability to type a couple of commands in a DOS command window
  13 - under POSIX OSes, lua and luac executables in your path, in versions >=5.1
  14
  15 MS-Windows
  16 ----------
  17
  18 - get the sources
  19 - cd metalua\src
  20 - edit make.bat to set your variables:
  21   * DISTRIB_BIN: where you want to put executables metalua.bat, lua.exe, luac.exe.
  22     This directory should be referenced in your PATH environment variable.
  23   * DISTRIB_LIB: where you want to put your Lua libraries. It shouldn't mess up
  24     an existing Lua libraries directory. This folder should be referrenced in your
  25     LUA_PATH environment variable.
  26 - run make.bat
  27
  28 Unix
  29 ----
  30
  31 - get the sources
  32 - cd metalua/src
  33 - set these variables or modify them in make.sh:
  34   * BUILD: a directory in which metalua should be built.
  35     Must be writable by the user.
  36   * INSTALL_BIN: where metalua will be copied
  37   * INSTALL_LIB: where (meta)lua libs will be copied. Should be
  38     referenced in your LUA_PATH.
  39 - run ./make.sh, under your UID
  40 - a ./make-install.sh script should have been generated, run it. If you
  41   want to install it in a directory that doesn't belong to you, you
  42   might want to run it as root.
  43 - if you don't want to edit make.sh, this will do:
  44   DESTDIR=/opt/metalua/git-1 \
  45   INSTALL_BIN=/usr/local/bin \
  46   INSTALL_LIB=/usr/local/lib/lua/5.1 \
  47   ./make.sh
  48   If this run is successful, do:
  49   DESTDIR=/opt/metalua/git-1 \
  50   INSTALL_BIN=/usr/local/bin \
  51   INSTALL_LIB=/usr/local/lib/lua/5.1 \
  52   ./make-install.sh
  53   if no packaging is required, just leave out the "DESTDIR=... \" line.
  54   If you want metalua to reside in the same space as distribution
  55   supplied files in "/usr" instead of "/usr/local", you propably want to
  56   leave out "local/" in the paths above.
  57
  58 Test drive
  59 ----------
  60 There are some samples in metalua/src/samples, which can be run simply by
  61 typing in the shell `metalua samplename.mlua`. Use `metalua -h` to
  62 have an overview of interesting options. Among them, "-a" dumps the
  63 AST resulting from a compilation: that's the perfect learning tool for
  64 practical-oriented minds.
  65
  66 Once you've played with the samples, and maybe written a couple of
  67 simple programs, I'm afraid the next step will be to RTFM :)
  68