From b1cfc1a4be46babbbb4aca9e2b93d41a3d75737b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alf-Andr=C3=A9=20Walla?= Date: Tue, 26 Nov 2024 22:40:37 +0100 Subject: [PATCH] Add README.md --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a9a96f1 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Godot Sandbox Programs + +This repository can be used as a starting point for automatically building and maintaining Sandbox programs with CMake. + +All programs are built in CI using a modern C/C++ RISC-V toolchain, with access to the Godot Sandbox C++ API, and automatically zipped and uploaded to a Draft release. Fork this repository and build your own Sandbox programs in a maintainable way! + + +## Example programs + +### Hello World + +The [Hello World example](/hello-world) is a minimal project that can be used as a starting point for anyone who wants to write Sandbox programs using modern C++. + +### Asm JIT example + +A [RISC-V assembler](/asm) is embedded into a Sandbox program. It will assemble RISC-V and return a callable. + +### LuaJit example + +[LuaJit is embedded](/luajit) into a Sandbox program. It can be used to run JIT-compiled Lua at run-time. + +### libtcc example + +[Libtcc is embedded](/libtcc) into a Sandbox program. It can be used to compile and run C-code at run-time. + +### Mir example + +[Mir is embedded](/mir) into a Sandbox program. It can be used to compile and run C-code at run-time.