Browse Source

Update README

Hugo Musso Gualandi 5 years ago
parent
commit
4e2dc2b7f2
1 changed files with 10 additions and 0 deletions
  1. 10 0
      README

+ 10 - 0
README

@@ -1,3 +1,5 @@
+# Lua-AOT 5.4
+
 This is a modified version of Lua 5.4.0 (beta) that allows Lua functions to be compiled ahead-of-time to more efficient code. It also includes a compiler called `luaot` that converts a Lua module to an equivalent one written in C.
 This is a modified version of Lua 5.4.0 (beta) that allows Lua functions to be compiled ahead-of-time to more efficient code. It also includes a compiler called `luaot` that converts a Lua module to an equivalent one written in C.
 
 
 The luaot compiler is a simplistic compiler that compiles Lua bytecode to C. 
 The luaot compiler is a simplistic compiler that compiles Lua bytecode to C. 
@@ -7,6 +9,14 @@ Additionally, the C compiler will be able to optimize some kinds of things, spec
 
 
 The performance gains depend on the kind of program being run. For numerical benchmarks it can be twice as fast as regular Lua. But overall, it isn't super impressive, and is not as fast as LuaJIT or Pallene.
 The performance gains depend on the kind of program being run. For numerical benchmarks it can be twice as fast as regular Lua. But overall, it isn't super impressive, and is not as fast as LuaJIT or Pallene.
 
 
+#Usage
+
+
+    ./src/luaot test.lua testcompiled.c
+    gcc -shared -fPIC -O2 -I./src testcompiled.c -o testcompiled.so
+    ./src/lua -l testcompiled
+
+
 For installation instructions, license details, and
 For installation instructions, license details, and
 further information about Lua, see doc/readme.html.
 further information about Lua, see doc/readme.html.