diff --git a/README.html b/README.html
index d91ae8c9..7004a54b 100644
--- a/README.html
+++ b/README.html
@@ -17,36 +17,64 @@
Getting Started with LuaJ
-James Roseborough, Ian Farmer, Version 1.9.53
+James Roseborough, Ian Farmer, Version 2.0-alpha1
-Copyright © 2007-2009 Luaj.org.
+Copyright © 2009-2010 Luaj.org.
Freely available under the terms of the
Luaj license.
-examples
+introduction
·
-concepts
+examples
·
-libraries
+concepts
·
-building
+libraries
·
-downloads
+building
·
-release notes
+downloads
+·
+release notes
-This is a development release for a planned luaj 2.0. The most recent stable release is 1.0.2
+This is an alpha release for a luaj 2.0. The most recent stable release is 1.0.3
+
+Goals of Luaj
+Luaj is a lua interpreter based on the 5.1.x line of lua with the following goals in mind:
+
+- Java-centric implementation to take advantage of native Java features like garbage collection, and a robust class model.
+
- Lightweight to allow for small, fast interpretation of lua bytecode.
+
- Complete set of libraries and tools for integration into real-world projects.
+
- Multi-platform to be able to run on JME, JSE, or JEE environments.
+
- Dependable due to sufficient unit testing of vm and library features.
+
-
+Differences with 1.0
+In addition to the basic goals of luaj, version 2.0 is aimed
+at improving on the 1.0 vm in the following aspects.
+
+- Support for compiling lua into Java off-line for JME, and at runtime for JSE.
+
- More alignment with C API (see names.csv for details)
+
- Faster bytecode processing for interpreted code.
+
- Tighter integration between lua and Java layers.
+
- Stackless implementation of interpreted code.
+
- Streamlined processing model with modular interpreter.
+
- More uniform naming of classes.
+
- Better package layout.
+
- Better unit tests of core classes.
+
+
+
+
Run a script in Java SE
@@ -54,7 +82,7 @@ This is a development release for a planned luaj 2.0. The most recent stable re
From the main distribution directory line type:
- java -cp lib/luaj-jse-1.9.53.jar lua examples/lua/hello.lua
+ java -cp lib/luaj-jse-2.0-alpha1.jar lua examples/lua/hello.lua
@@ -99,7 +127,7 @@ A simple example may be found in
-You must include the library lib/luaj-jse-1.9.53.jar in your class path.
+You must include the library lib/luaj-jse-2.0-alpha1.jar in your class path.
Run a script in a MIDlet
@@ -128,7 +156,7 @@ A simple example may be found in
-You must include the library lib/luaj-jme-1.9.53.jar in your midlet jar.
+You must include the library lib/luaj-jme-2.0-alpha1.jar in your midlet jar.
They can be obfuscated if desired.
Including the compiler
@@ -163,7 +191,7 @@ The standard use of JSR-233 scripting engines may be used:
All standard aspects of script engines including compiled statements should be supported.
-You must include the library lib/luaj-jse-1.9.53.jar in your class path.
+You must include the library lib/luaj-jse-2.0-alpha1.jar in your class path.
A working example may be found in
@@ -181,7 +209,7 @@ bcel library is now included.
To use it at runtime, the tool "lua" has an option "-j" to compile into java bytecode.
- java -cp luaj-jse-1.9.53.jar;lib/bcel-5.2.jar lua -j examples/lua/hello.lua
+ java -cp luaj-jse-2.0-alpha1.jar;lib/bcel-5.2.jar lua -j examples/lua/hello.lua
@@ -189,7 +217,7 @@ To compile lua files into Java in advance, the tool "luajc" is provided:
cp examples/lua/hello.lua .
- java -cp luaj-jse-1.9.53.jar;lib/bcel-5.2.jar luajc hello.lua
+ java -cp luaj-jse-2.0-alpha1.jar;lib/bcel-5.2.jar luajc hello.lua
ls -l hello.class
@@ -206,14 +234,14 @@ Files compiled into java in this way can be run via Java class loading, with
(generated class files must be in your class path):
- java -cp luaj-jse-1.9.53.jar;. lua -l hello
+ java -cp luaj-jse-2.0-alpha1.jar;. lua -l hello
The current bytecode generator produces a separate class file for each prototype,
and generated class files do not work properly with module() or setfenv().
-
+
Globals
The old notion of platform has been replaced with creation of globals.
@@ -235,7 +263,7 @@ All libraries are included except luajava, and the os, io, and math libraries ar
limited to those functions that can be supported on that platform.
-
+
Standard Libraries
@@ -324,13 +352,13 @@ The following lua script will open a swiing frame on Java SE:
See a longer sample in src/test/res/swingapp.lua for details, or try running it using:
- java -cp lib/luaj-jse-1.9.53.jar lua src/test/res/swingapp.lua
+ java -cp lib/luaj-jse-2.0-alpha1.jar lua src/test/res/swingapp.lua
The Java ME platform does not include this library, and it cannot be made to work because of the lack of a reflection API in Java SE.
-
+
Building the jars
An ant file is included in the root directory which builds the libraries by default.
@@ -355,10 +383,10 @@ A large set of JUnit tests are invoked by the JUnit 3 suite:
These tests are used for to produce code coverage statistics using build-coverage.xml.
-
+
Downloads and Project Pages
-Downloads for version 1.0.2 are currently hosted on SourceForge.
+Downloads for version 1.0.3 are currently hosted on SourceForge.
Downloads of built packages for 2.0 are not yet available.
Sources are available via sourceforge.net
@@ -373,15 +401,21 @@ and LuaForge:
LuaForge Luaj Project Area
-
+
-Main changes by version:
+Main Changes by Version
-| 1.9.53 |
-Most interpreter features are working. Initial port of all libraries has been done.
- |
-| 1.9.53 |
-All unit tests that have been included in the project pass.
-Compile-to-Java based on bcel 5.2 is working.
- |
+| 2.0-alpha1 |
+- All basic bunit tests pass.
+
- Initial port of all libraries has been done.
+
- Compile-to-Java based on bcel 5.2.
+
|
+
+Known Issues
+
+- module() and setfenv() don't work with compiled code
+
- debug code may not be removed by obfuscators
+
- not all luajava bugfixes have been ported over
+
+
diff --git a/version.properties b/version.properties
index b7da5bf1..6e50d45e 100644
--- a/version.properties
+++ b/version.properties
@@ -1,2 +1,2 @@
# on the way to version 2.0
-version: 1.9.53
+version: 2.0-alpha1
|