INSTALL

   1 * Installation
   2
   3   Building Lua on a Unix system should be very easy:
   4
   5         1. Edit "config" to suit your platform, if at all necessary
   6         2. Then, type "make"
   7
   8   See below for instructions for Windows and Macintosh.
   9
  10 * What you get
  11
  12   If make succeeds, you get:
  13         * an interpreter and a compiler in ./bin;
  14         * libraries in ./lib;
  15         * include files in ./include.
  16   These are the only directories you need for development.
  17
  18   There is a reference manual in html in ./doc, and sample code in ./test.
  19   You don't need these directories for development.
  20
  21 * If you have problems (and solutions!)
  22
  23   If "make" fails, please let us know (lua@tecgraf.puc-rio.br).
  24   If you make changes to "config", please send them to us.
  25
  26 * Shared libraries
  27
  28   If you are running SunOs 4.x, type the following after "make" succeeds:
  29         ld -o lib/liblua.so.3.0 src/*.o
  30         ld -o lib/liblualib.so.3.0 clients/lib/*.o
  31
  32   For AIX, the OpenGL clone Mesa includes a script for making shared libraries.
  33   For other systems, please tell us how!
  34
  35 * Installation on Windows or Macintosh
  36
  37   The instructions for building Lua on a Mac or Windows machine depend on
  38   the particular compiler you are using.
  39   The simplest way is to create a folder with all .c and .h files.
  40   Then create projects for the basic library, the standard library,
  41   the interpreter and the compiler, as follows:
  42
  43   basic lib:    auxlib.c fallback.c func.c hash.c inout.c lex.c luamem.c
  44                 opcode.c parser.c table.c tree.c undump.c zio.c
  45
  46   standard lib: iolib.c mathlib.c strlib.c
  47
  48   interpreter:  basic lib, standard lib, lua.c
  49
  50   compiler:     basic lib, dump.c luac.c print.c
  51
  52   Of course, to use Lua as a library, you'll have to know how to create
  53   libraries and use with your compiler.