Revert "Remove contributions from user https://github.com/eamonburns in preparation for relicensing"

This reverts commit 6bdb102.

Author: thsackos

README.md

@@ -84,25 +84,6 @@ Some examples are provided in [examples/](./examples/) to aid users in learning
 small self-contained applications should always be working, please create an issue if they do not work for
 you.
 
-```zig
-const std = @import("std");
-const Lua = @import("luajit").Lua;
-
-pub fn main() !void {
-    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
-    defer _ = gpa.deinit();
-
-    const lua = try Lua.init(gpa.allocator());
-    defer lua.deinit();
-
-    lua.openBaseLib();
-
-    try lua.doString(
-        \\ message = "Hello, world!"
-        \\ print(message)
-    );
-}
-```
 
 ## Language Binding Coverage Progress
 

examples/README.md

@@ -0,0 +1,24 @@
+# Examples
+
+Unless otherwise noted, the `build.zig` files are functionally the same between them.
+
+## Basic Examples
+
+Inspired by this [Lua C API "Cheat Sheet"](https://www.codingwiththomas.com/blog/a-lua-c-api-cheat-sheet).
+
+1. [Run Lua code from Zig](./example-01_run-lua)
+2. [Lua variables in Zig, and vice versa](./example-02_variables)
+3. [Lua functions in Zig](./example-03_lua-functions)
+4. [Zig functions in Lua](./example-04_zig-functions)
+5. [Zig structs (userdata) in Lua](./example-05_userdata)
+6. [Lua tables in Zig](./example-06_lua-tables)
+
+## Miscellaneous
+
+- [Simple REPL](./simple-repl)
+
+## Userdata, in-depth
+
+Based on [Programming in Lua, chapter 28](https://www.lua.org/pil/28.html).
+
+(To-do)

examples/example-01_run-lua/LAST_TESTED_WITH_ZIG_VERSION.txt

@@ -0,0 +1,2 @@
+0.15.0-dev.565+8e72a2528
+

examples/example-01_run-lua/README.md

@@ -0,0 +1,3 @@
+# Run Lua code from Zig
+
+This is a simple example of how to run Lua code from Zig.

examples/example-01_run-lua/build.zig

@@ -0,0 +1,51 @@
+const std = @import("std");
+
+pub fn build(b: *std.Build) void {
+    const target = b.standardTargetOptions(.{});
+    const optimize = b.standardOptimizeOption(.{});
+
+    const exe = normalBuildStepsFromZigInit(b, target, optimize);
+    installZigLuajit(b, target, optimize, exe);
+}
+
+fn normalBuildStepsFromZigInit(
+    b: *std.Build,
+    target: std.Build.ResolvedTarget,
+    optimize: std.builtin.OptimizeMode,
+) *std.Build.Step.Compile {
+    const exe_mod = b.createModule(.{
+        .root_source_file = b.path("src/main.zig"),
+        .target = target,
+        .optimize = optimize,
+    });
+    const exe = b.addExecutable(.{
+        .name = "example",
+        .root_module = exe_mod,
+    });
+    b.installArtifact(exe);
+    const run_cmd = b.addRunArtifact(exe);
+    run_cmd.step.dependOn(b.getInstallStep());
+
+    if (b.args) |args| {
+        run_cmd.addArgs(args);
+    }
+
+    const run_step = b.step("run", "Run the app");
+    run_step.dependOn(&run_cmd.step);
+
+    return exe;
+}
+
+fn installZigLuajit(
+    b: *std.Build,
+    target: std.Build.ResolvedTarget,
+    optimize: std.builtin.OptimizeMode,
+    exe: *std.Build.Step.Compile,
+) void {
+    const luajit_dep = b.dependency("luajit", .{
+        .target = target,
+        .optimize = optimize,
+    });
+    const luajit = luajit_dep.module("luajit");
+    exe.root_module.addImport("luajit", luajit);
+}

examples/example-01_run-lua/build.zig.zon

@@ -0,0 +1,15 @@
+.{
+    .name = .example01_run_lua,
+    .fingerprint = 0xf5e7b2350a95160a,
+    .version = "0.0.0",
+    .dependencies = .{
+        .luajit = .{
+            .path = "../..",
+        },
+    },
+    .paths = .{
+        "build.zig",
+        "build.zig.zon",
+        "src",
+    },
+}

examples/example-01_run-lua/src/main.zig

@@ -0,0 +1,39 @@
+//! Copyright (c) 2024-2025 Theodore Sackos
+//! SPDX-License-Identifier: AGPL-3.0-or-later
+
+const std = @import("std");
+const print = std.debug.print;
+const Lua = @import("luajit").Lua;
+
+pub fn main() !void {
+    // Boilerplate
+    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
+    defer _ = gpa.deinit();
+
+    const allocator = gpa.allocator();
+    const lua = try Lua.init(allocator);
+    defer lua.deinit();
+    // End boilerplate
+
+    lua.openBaseLib();
+
+    print("[Zig] Hello, World!\n", .{});
+
+    // Run some Lua code contained in a string
+    lua.doString(
+        \\ print("[Lua] Hello, Lua!")
+    ) catch unreachable; // We don't care about error handling right now
+
+    // You can also run Lua code in a file
+    lua.doFile("./src/script.lua") catch |err| switch (err) {
+        error.FileOpenOrFileRead => print("[Zig] Can't find the file 'src/script.lua'. Are you in the correct directory?\n", .{}),
+        error.Runtime => {
+            // A "Runtime" error is an error that happened while the Lua code was running.
+            // In this case, an error message will often be left at the top of the stack.
+
+            const message = lua.toString(-1) catch "unknown"; // If the error message can't be converted to a string, then just use the string "unknown"
+            print("[Zig] An error occurred while running the script: {s}\n", .{message});
+        },
+        else => unreachable,
+    };
+}

examples/example-01_run-lua/src/script.lua

@@ -0,0 +1 @@
+print("[Lua] Hello from a file!")

examples/example-02_variables/LAST_TESTED_WITH_ZIG_VERSION.txt

@@ -0,0 +1,2 @@
+0.15.0-dev.565+8e72a2528
+

examples/example-02_variables/README.md

@@ -0,0 +1,3 @@
+# Passing variables to/from Lua
+
+This is an example of how to pass variables to Lua, and get variables from Lua.