summaryrefslogtreecommitdiff
path: root/examples/scripting/lua/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/scripting/lua/README.md')
-rw-r--r--examples/scripting/lua/README.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/examples/scripting/lua/README.md b/examples/scripting/lua/README.md
new file mode 100644
index 0000000..dea8fa2
--- /dev/null
+++ b/examples/scripting/lua/README.md
@@ -0,0 +1,46 @@
+# Lua Scripting with Zen-C
+
+This examples demonstrates how to build your Zen-C application with Lua C bindings,<br>
+and how you can call Lua code from Zen-C (.zc) context, or exposed Zen-C functions from Lua (.lua) context.
+
+> Lua is a powerful, efficient, lightweight, embeddable scripting language, often used in games.
+
+---
+
+Example output:
+
+![alt text](https://i.imgur.com/5vfGuVg.png)
+
+## Setup
+
+Get Lua 5.4 headers and lib:
+
+```sh
+./deps.sh
+```
+
+This will leave the headers (.h) and lib (.a) inside a folder called ``lua``.
+
+## Build
+
+```sh
+zc build lua.zc -o lua
+```
+
+## Run
+
+Either
+
+```sh
+zc run lua.zc
+```
+
+or (after compilation)
+
+```sh
+./lua
+```
+
+## Documentation
+
+- https://www.lua.org/manual/5.4/manual.html