examples/mnit_dino: add a README.md file
authorAlexis Laferrière <alexis.laf@xymus.net>
Fri, 28 Aug 2015 18:13:59 +0000 (14:13 -0400)
committerAlexis Laferrière <alexis.laf@xymus.net>
Fri, 28 Aug 2015 18:14:28 +0000 (14:14 -0400)
Signed-off-by: Alexis Laferrière <alexis.laf@xymus.net>

examples/mnit_dino/README.md [new file with mode: 0644]

diff --git a/examples/mnit_dino/README.md b/examples/mnit_dino/README.md
new file mode 100644 (file)
index 0000000..dc46a12
--- /dev/null
@@ -0,0 +1,11 @@
+Dino vs cavemen portable action game where the player plays the dino
+
+# Project Structure
+
+* `game_logic` defines, as its name implies, the full game logic and the basic entities.
+* `graphism` defines how the game is drawn on screen with fully portable code.
+* `dino` implements the the portable app structure.
+* `dino_android` and `dino_linux` adapt the portable game for specific platforms.
+* `fancy_dino` is an optional module which tweaks how the dino itself is drawn on screen
+  to create the flat rotation effect.
+* `splash` defines the splash screen used while the app loads.