summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README57
1 files changed, 41 insertions, 16 deletions
diff --git a/README b/README
index 29ad01d5..3b8ad6aa 100644
--- a/README
+++ b/README
@@ -1,22 +1,47 @@
-This is Lua 1.0. It was never publicly released. This code is a snapshot of
-the status of Lua on 28 Jul 1993. It is distributed for historical curiosity
-to celebrate 10 years of Lua and is hereby placed in the public domain.
+* What is Lua?
+ Lua is a simple, yet powerful, language for extending applications.
+ Lua has been developed by TeCGraf, the Computer Graphics Technology Group
+ of PUC-Rio, the Pontifical Catholic University of Rio de Janeiro, Brazil.
+ Dozens of industrial products developed by TeCGraf use Lua.
-There is no documentation, except the test programs. The manual for Lua 1.1
-probably works for this version as well.
+* Some features of Lua
+ Lua has a simple, pascal-like, syntax.
+ Variables need no declaration, but Lua has user-controlled type constructors.
+ Lua has powerful data description constructs (e.g., associative arrays).
+ Functions can receive a variable number of arguments and can return multiple
+ values.
+ Lua programs are compiled into bytecodes, which are then interpreted to
+ simulate a virtual machine.
+ Lua is written in ANSI C and is completely portable.
-The source files for the lexer and parser have been lost: all that is left is
-the output of lex and yacc. A grammar can be found inside y_tab.c in yyreds.
+* Coming soon
+ Object-oriented extensions.
+ Lazy evaluation.
-The code compiles and runs in RedHat 5.2 with gcc 2.7.2.3. It may not run in
-newer systems, because it assumes that stdin and stdout are constants, though
-ANSI C does not promise they are. If make fails, try using the fixed modules
-provided in the "fixed" directory. To see the differences (which are really
-quite minor), do "make diff".
+* Installing
+ To make, simply type domake.
+ If make succeeds, you get an interpreter in ./bin/lua.
+ The libraries are in ./lib. The include files are in ./include.
+ You don't need the other directories for development.
+ There is documentation in ./doc and tests in ./test.
+ The documentation includes a reference manual and an article on the
+ design and implementation of Lua.
+ This distribution is biased towards SunOS 4 with gcc but it is simple to
+ change the Makefiles for other systems.
-To see Lua 1.0 in action, do "make test". (The last test raises an error on
-purpose.)
+* Legal matters
+ Lua is not in the public domain; TeCGraf keeps its copyright.
+ Nevertheless, Lua is freely available for academic purposes by anonymous ftp
+ at ftp.icad.puc-rio.br:/pub/lua/lua-1.1.tar.Z.
+ For commercial purposes, please contact us.
-Enjoy!
+* Contacting the authors
+ Send your comments, bug reports and anything else to lhf@icad.puc-rio.br.
+ Please send me email if you download Lua so that we can know how far it goes.
--- The Lua team, lua@tecgraf.puc-rio.br
+--
+Luiz Henrique de Figueiredo email: lhf@icad.puc-rio.br
+TeCGraf-Grupo de Tecnologia em Computacao Grafica, ITS, PUC-Rio
+Rua Marques de Sao Vicente 225 voice: +55 21 529-9424
+22453-900 Rio de Janeiro, RJ, Brasil fax: +55 21 511-5645
+--