summary refs log tree commit diff homepage
path: root/README.rst
diff options
context:
space:
mode:
authorNguyễn Gia Phong <vn.mcsinyx@gmail.com>2017-10-20 20:51:39 +0700
committerNguyễn Gia Phong <vn.mcsinyx@gmail.com>2017-10-20 20:51:39 +0700
commit81d0b68811283f35645d16bdec3aa7eae621cd02 (patch)
tree3d590469a263793df6806560fe4e365f7b031a7a /README.rst
parent43c7c55a396968d013e01648d77625ad6075f418 (diff)
downloadbrutalmaze-81d0b68811283f35645d16bdec3aa7eae621cd02.tar.gz
Update README.rst and clean up a bit
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst26
1 files changed, 21 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index 090edff..eab00b8 100644
--- a/README.rst
+++ b/README.rst
@@ -1,20 +1,36 @@
 Brutal Maze
 ===========
 
-**Brutal Maze** is a research hash and slash game with *polyart* graphic and
-Tango color palette. Its primary goals are:
+Brutal Maze is a research hash and slash game with fast-paced action and a
+minimalist art style.
+
+.. image:: https://raw.githubusercontent.com/McSinyx/brutalmaze/master/brutalmaze/icon.png
+
+The game features a trigon trapped in an infinite maze. As our hero tries to
+escape, the maze's border turn into aggressive squares trying to stop him. Your
+job is to help the trigon fight against those evil squares and find a way out
+(if there is any). Be aware that the more get killed, the more will show up and
+our hero will get weaker when wounded.
+
+As a research game, Brutal Maze has a few primary goals:
 
 * Highly portable.
 * Auto-generated and infinite maze.
-* No binary data.
+* No binary art data.
 * Enemies with randomized attributes: stun, poison, etc.
 * Resizable in realtime.
 
 Installation
 ------------
 
-**Brutal Maze** can run on both Python 2 and 3. You can install it using
-``pip`` or run ``./setup.py install --user``.
+Brutal Maze is written in Python and is compatible with both version 2 and 3.
+The installation procedure should be as simply as follow:
+
+* Make sure you have Python and `pip <https://pip.pypa.io/en/latest/>`_
+  installed on your system.
+* Clone the Github repository or download the Zip achieve and unpack.
+* Open Terminal in the directory containing the repo's folder and run
+  ``pip install --user brutalmaze``.
 
 Control
 -------