summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..405d4a3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# Bidi - Game development framework
+
+Bidi is a tiny framework for developing small video games for recreational
+purpose. It takes heavy inspiration from LÖVE and Pico8.
+
+You develop your games in Lua and you are only allowed to have one Lua file
+where all your code lives. You can then load external assets like images and
+sounds.
+
+## Libraries
+
+- https://github.com/rxi/microtar
+- https://github.com/lua/lua
+- https://github.com/raysan5/raylib
+
+## Inspiration & Materials
+
+https://www.love2d.org/wiki/Main_Page
+https://www.lexaloffle.com/dl/docs/pico-8_manual.html