Add ReadMe file

vitalibo · Jan 3, 2017 · 9532bc0 · 9532bc0
1 parent 428d10b
commit 9532bc0
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,41 @@
+## Brick Game 9999 in 1 
+
+This project is simple simulator of famous Brick Game handheld retro gaming console. 
+
+### Installation
+
+`mvn clean package`
+
+launch game
+
+`java -jar brick-game-0.3.0-SNAPSHOT.jar`
+
+### Usage
+
+##### Control keys
+
+- Default keys (independent of the game) 
+    - `Key 'P'` - On/Off **P**ause
+    - `Key 'S'` - On/Off **S**ound
+    - `Key 'R'` - **R**eset the brick game
+- Functional keys
+    - `Key Up` - change speed in menu or specific in game
+    - `Key Down` - change level in menu or specific in game
+    - `Key Left` - decrease the number of game in menu or specific in game
+    - `Key Right` - increase the number of game in menu or specific in game
+    - `Key Space` - choose game in menu or specific in game
+
+##### View
+
+![](docs/img/sR35V1.gif)
+
+- Board panel `capacity [20x10]`
+- Preview panel `capacity [4x4]`
+- Score `max 999999`
+- Speed `max 18`
+- Level `max 18`
+- Sound `on/off`
+- Pause `on/off`
+
+### Games
+
diff --git a/docs/img/sR35V1.gif b/docs/img/sR35V1.gif