From e72bfc339b013a69fd96c09c926df9c43abc60e8 Mon Sep 17 00:00:00 2001
From: Lonami Exo <totufals@hotmail.com>
Date: Tue, 31 Jan 2017 12:30:07 +0100
Subject: [PATCH] Add README and CONTRIBUTORS

---
 CONTRIBUTORS.md | 19 ++++++++++++++
 README.md       | 69 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 88 insertions(+)
 create mode 100644 CONTRIBUTORS.md
 create mode 100644 README.md

diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
new file mode 100644
index 0000000..59d1862
--- /dev/null
+++ b/CONTRIBUTORS.md
@@ -0,0 +1,19 @@
+Original idea
+=============
+- [Gram Games Team](http://gram.gs/)
+
+Programming
+===========
+- [Lonami Exo](https://lonamiwebs.github.io/)
+
+Art
+===
+- [Lonami Exo](https://lonamiwebs.github.io/)
+
+Sounds
+======
+- `game_over` by [BerduSmith](http://freesound.org/people/BerduSmith/sounds/335395/`)
+- `piece_drop` by [cabled_mess](http://freesound.org/people/cabled_mess/sounds/350906/)
+- `invalid_drop` by [fins](http://freesound.org/people/fins/sounds/146726/)
+- `strip_clear` by [Kastenfrosch](http://freesound.org/people/Kastenfrosch/sounds/162461/)
+- `take_pieces` by [LloydEvans09](http://freesound.org/people/LloydEvans09/sounds/321806/)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6be95c9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,69 @@
+Klooni 1010!
+============
+Play 1010! for free! Add your own themes! Contribute! Make the game yours!
+
+This project is licensed under the [MIT License](LICENSE).
+
+**Table of contents**:
+1. [Disclaimer](#disclaimer)
+2. [Description](#description)
+3. [Building](#building)
+4. [Playing](#playing)
+5. [Contributing](#contributing)
+6. [Contributors](#contributors)
+
+Disclaimer
+----------
+**Klooni 1010!** is a [libGDX](https://libgdx.badlogicgames.com/)-based game
+which is a *klooni* from the original [1010!](http://1010ga.me/) game by the
+[Gram Games](http://gram.gs/) team. I am **not affiliated** in any way with
+them and this is only a project I made for fun, and to improve the gaming
+experience of the open source community.
+
+Description
+-----------
+*Klooni 1010!* is an open source copy of *1010!* with the same game-play
+dynamics of the original game. I tried to mimic it as much as possible,
+yet, not everything is exactly the same. For example, the customize screen
+is different, there are no ads or in-app purchases, different sounds, etc.
+
+Building
+--------
+Building the project should be very straight forward:
+1. `git clone https://github.com/LonamiWeb/Klooni1010.git`.
+2. `cd Klooni1010`
+3. Now you can choose to either build for `desktop` or `android`:
+   1. For desktop, use `./gradlew desktop:dist`
+   2. For Android, use `./gradlew android:assembleRelease`
+4. You're done! The generated files are under `build`:
+   1. Desktop build is under `desktop/build/libs/*.jar`
+   2. Android build is under `android/build/outputs/apk/*.apk`
+
+Playing
+-------
+If you're on desktop, you should be able to play the game by either double
+clicking the built game `.jar` (Windows) or running `java -jar {file}.jar`.
+
+If you want to play the game on Android, move the built `.apk` to your phone's
+internal memory, find it with an Android file explorer and install it.
+Make sure you have `Unknown sources` (`Settings -> Security`) enabled!
+
+Contributing
+------------
+Found a bug? Did you add new sounds? Explosions (that would be cool)? Did
+you create a new theme you'd like to see in the game? That's **awesome**!
+Every pull request is appreciated (or even drop an issue if you don't know
+how these work), although they will probably be discussed before merging!
+
+All you need to do is make sure you did not violate any of the following:
+- New sounds must be either *yours* or be under a `Creative Commons` license.
+  The same applies to new textures.
+- There is no real rule when writing code to patch a bug or adding features.
+  Just make sure it's readable enough and, if you write a method which name
+  is not self-explanatory, document it and explain what it does.
+- Make sure you add yourself (in **alphabetical order**) to the
+  `CONTRIBUTORS.md` file :)
+
+Contributors
+------------
+Check out the [`CONTRIBUTORS.md`](CONTRIBUTORS.md) file!
\ No newline at end of file