aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a164756
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# LibreForts
+
+Open-source clone of Forts, a 2D physics artillery RTS. Custom C++ engine,
+content driven by Lua. Work in progress. See CLAUDE.md for details.
+
+## Stack
+
+C++20, Meson/Ninja (Podman), SDL3, Dear ImGui, a custom mass-spring physics
+solver, Lua 5.4 with sol2, and stb_image.
+
+## Build and run
+
+```sh
+podman build -t forts-clone-dev .
+podman run --rm -v "$PWD":/src:Z --userns=keep-id localhost/forts-clone-dev:latest \
+ sh -c "cd /src && meson setup builddir && meson compile -C builddir"
+./builddir/forts-clone # run from repo root
+```
+
+## Assets
+
+The repo ships CC0 placeholders only. If you own Forts, real textures load at
+runtime from your install via `forts:` paths (set `$FORTS_DATA`). Nothing
+copyrighted is stored here. Forts is copyright EarthWork Games.