From b101db9c91c484291f4c9442c4838eab1d095d84 Mon Sep 17 00:00:00 2001 From: Kevin MacMartin Date: Thu, 29 May 2014 13:47:39 -0400 Subject: [PATCH] Added a LICENSE file and README in markdown --- LICENSE | 21 ++++++++++++++++++ README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 87 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4d6f7c9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2014 Kevin M + +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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..c35a6e4 --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +# Intelligent Snake # + +Intelligent Snake is a simple clone of the famous **snake**-style games. It's meant both as a fun time waster as well as a simple working SDL program to learn from and use as a reference. + +![Intelligent Snake](http://i.imgur.com/p80DyKz.png) + +## Compile ## + +### Linux ### + +#### Requirements #### + +* **make** +* **gcc** +* **SDL** (version 1.2) +* **SDL_ttf** + +#### Build #### + +* `make`: Build Intelligent Snake and copy required files to ./bin/ +* `make clean`: Remove build directories + +### Windows ### + +#### Requirements #### + +* **make** +* **mingw-w64** +* **mingw-w64-sdl** (version 1.2) +* **mingw-w64-sdl_ttf** + +#### Build #### + +* `make windows`: Build Intelligent Snake for Windows and copy required files to ./windows-bin/ +* `make clean`: Remove build directories + +## Commands ## + +Usage: `./isnake [options]` + +### Options ### + +* `./isnake`: Start the game with the default options +* `./isnake -g [width] [height]`: Set the grid size: between [30]x[20] and [80]x[50] (DEFAULT: [50]x[30]) +* `./isnake -b [blocks]`: Set the number of blocks: between [0] and [40] (DEFAULT: [20]) +* `./isnake -l [length]`: Set the snake's starting length: between [3] and [35] (DEFAULT: [3]) +* `./isnake -s [speed]`: Set the snake's starting speed: between [1] and [9] (DEFAULT: [1]) +* `./isnake -h`: Display help information + +## Controls ## + +* **Movement** + * **FPS Keys**: `w`, `a`, `s` and `d` + * **Vim Keys**: `k`, `h`, `j` and `l` + * **Arrow Keys**: `up`, `left`, `down` and `right` +* **Quit**: `Escape` and `Q` +* **Restart** (after death): `Space` and `Return` + +## Credits ## + +* Written by Kevin MacMartin: [GitHub Projects](https://github.com/prurigro?tab=repositories) | [Arch Linux AUR Packages](https://aur.archlinux.org/packages/?SeB=m&K=prurigro) + +## License ## + +* **Intelligent Snake**: [The MIT License](http://opensource.org/licenses/MIT) +* **Font** ([DroidSans-Bold.ttf](https://www.google.com/fonts/specimen/Droid+Sans)): [Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)