First commit!

1 files changed, 47 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..daa87c3
--- /dev/null
+++ b/README
@@ -0,0 +1,47 @@
+-*- org -*-
+
+#+TITLE The Chickadee Game Development Toolkit
+
+* About
+
+  Chickadee is a game development toolkit for Guile Scheme.
+
+  #+BEGIN_SRC scheme
+    (use-modules (chickadee))
+
+    (define sprite #f)
+
+    (define (load)
+      (set! sprite (load-image "chickadee.png")))
+
+    (define (render alpha)
+      (draw-sprite sprite (vector2 320 240)))
+
+    (run-game #:load load #:render render)
+  #+END_SRC
+
+* Features
+
+  Chickadee supports the following features:
+
+  - 2D/3D rendering engine via OpenGL
+    - Efficient sprite rendering
+    - Signed distance field font rendering
+    - Particles
+    - Simple geometric shapes
+    - GLSL shaders
+  - Keyboard/mouse/joystick input
+  - Sound effects and music
+  - 2D/3D/4D vector math library
+  - Axis-aligned bounding box library
+  - Fixed timestep game loop
+
+* Dependencies
+
+  - Guile >= 2.1.4
+  - Guile-OpenGL >= 0.1.0
+  - Guile-SDL2 >= 0.2.0
+
+* License
+
+  GNU GPL version 3 or later