forgotten files

dist/LICENCE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Ghislain Rodrigues
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dist/README.md

@@ -0,0 +1,55 @@
+# Floodit
+
+## Screenshots
+
+![screenshot](screenshots/main-menu.png "Main menu")
+![screenshot](screenshots/in-game.png "In game")
+![screenshot](screenshots/high-scores.png "High scores")
+
+## Dependancies
+
+Requires:
+
+* SDL2
+* SDL2_ttf
+* SDL2_net
+* SDL2_image
+
+## Compilation
+
+	make
+
+To compile for the GCW-zero, you need the toolchain (downloadable from the
+console's website), then:
+
+	make gcw CROSS_COMPILE=/opt/gcw0-toolchain/usr/bin/mipsel-linux-
+
+To package for the gcw zero, you will need the package squashfs-tools, then run
+
+	make opk
+
+Finally, to use your opk, copy it in your GCW-Zero. I use scp for that, but via
+ftp or on a memory card should work as well:
+
+	scp floodit.opk root@[gcwIp]:/media/data/apps/
+
+## How to play
+
+To start the game, run the executable ```floodit```.
+
+### PC controls
+
+* arrows to navigate in the menus and in the colors (while in game)
+* space to select a menu action or to select a color
+* escape to go back
+
+### GCW-Zero controls
+
+* D-Pad to navigate in the menus and in the colors (while in game)
+* A to select a menu action or to select a color
+* select to go back
+
+## Credits
+
+Font ClearSans from
+https://01.org/clear-sans/blogs/2013/clear-sans-new-font-optimized-small-screen-readability licenced under [Apache License v2.00](https://www.fontsquirrel.com/license/clear-sans)