From: Alexis Laferrière <alexis.laf@xymus.net>
Date: Sun, 13 Dec 2015 18:29:02 +0000 (-0500)
Subject: lib/gamnit: intro README.md
X-Git-Tag: v0.8~36^2~7
X-Git-Url: http://nitlanguage.org

lib/gamnit: intro README.md

Signed-off-by: Alexis Laferrière <alexis.laf@xymus.net>
---

diff --git a/lib/gamnit/REAME.md b/lib/gamnit/REAME.md
new file mode 100644
index 0000000..9d60cc0
--- /dev/null
+++ b/lib/gamnit/REAME.md
@@ -0,0 +1,18 @@
+Portable game and multimedia framework for Nit
+
+This framework is based on the portability framework _app.nit_ and the OpenGL ES 2.0 standard.
+
+It is modular, different parts of the framework are available through different entry points:
+
+* `gamnit` provides low-level abstractions over some services of OpenGL ES 2.0, like textures, shaders and programs.
+  It defines the basic methods to implement in order to obtain a working game: `App::frame_core` to update the screen
+  and `App::accept_event` to receive user inputs.
+
+* `simple_2d` provides an easy to use API for 2D games based on sprites.
+  Clients of this API must redefine `App::update` to update the game logic and fill `App::sprites` with objects to draw.
+
+* `cameras` provides cameras classes to produce MVP matrices which can be fed to shaders.
+
+* `limit_fps` redefines existing services of gamnit to limit the framerate to a client-defined value.
+
+* `network` provides a simple communication framework for multiplayer client/server games.