Imported from ../lua-1.1.tar.gz.
[lua.git] / README
blob3b8ad6aab97b1adf2ec641181b930553aa97a786
1 * What is Lua?
2   Lua is a simple, yet powerful, language for extending applications.
3   Lua has been developed by TeCGraf, the Computer Graphics Technology Group
4   of PUC-Rio, the Pontifical Catholic University of Rio de Janeiro, Brazil.
5   Dozens of industrial products developed by TeCGraf use Lua.
7 * Some features of Lua
8   Lua has a simple, pascal-like, syntax.
9   Variables need no declaration, but Lua has user-controlled type constructors.
10   Lua has powerful data description constructs (e.g., associative arrays).
11   Functions can receive a variable number of arguments and can return multiple
12   values.
13   Lua programs are compiled into bytecodes, which are then interpreted to
14   simulate a virtual machine.
15   Lua is written in ANSI C and is completely portable.
17 * Coming soon
18   Object-oriented extensions.
19   Lazy evaluation.
21 * Installing
22   To make, simply type domake.
23   If make succeeds, you get an interpreter in ./bin/lua.
24   The libraries are in ./lib.  The include files are in ./include.
25   You don't need the other directories for development.
26   There is documentation in ./doc and tests in ./test.
27   The documentation includes a reference manual and an article on the
28   design and implementation of Lua.
29   This distribution is biased towards SunOS 4 with gcc but it is simple to
30   change the Makefiles for other systems.
32 * Legal matters
33   Lua is not in the public domain;  TeCGraf keeps its copyright.
34   Nevertheless, Lua is freely available for academic purposes by anonymous ftp
35   at ftp.icad.puc-rio.br:/pub/lua/lua-1.1.tar.Z.
36   For commercial purposes, please contact us.
38 * Contacting the authors
39   Send your comments, bug reports and anything else to lhf@icad.puc-rio.br.
40   Please send me email if you download Lua so that we can know how far it goes.
43 Luiz Henrique de Figueiredo                          email: lhf@icad.puc-rio.br
44 TeCGraf-Grupo de Tecnologia em Computacao Grafica, ITS, PUC-Rio
45 Rua Marques de Sao Vicente 225                       voice: +55 21 529-9424
46 22453-900 Rio de Janeiro, RJ, Brasil                   fax: +55 21 511-5645