1 files changed, 58 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3bc8150
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+**Maze**
+
+maze is a command line maze game.
+
+Features
+--------
+
+- [x] Load/save maze from/to text file.
+- [x] Generate random maze.
+- [x] Solve maze.
+- [x] Help you solve maze by one move at once.
+- [x] Configurable key bindings in defaults.h.
+
+Dependencies
+------------
+
+* ncurses
+
+On ubuntu, you can install the dependencies by running the following command with root privilages:
+
+    # apt install libncurses-dev
+
+Installation
+------------
+
+Currently, this program is not available in any package manager, so you have to build it from source. You can run this command that will build and install the program on your system:
+
+    # make install
+
+By default, maze is installed using the prefix "/usr/local", so the full path of the executable will be "/usr/local/bin/maze".
+
+You can install maze into a directory of your choice by changing the second command to:
+
+    # make PREFIX="/your/dir" install
+
+In order to remove the program from your system, run the following command:
+
+    # make uninstall
+
+Please note that these commands require root privileges.
+
+If you don't want to install, just run it, you can do it in this way:
+
+    $ make
+    $ ./bin/maze
+
+Usage
+-----
+
+Please see the man page for more information.
+
+You can see the man page by runing the following command in the project directiory:
+
+    $ man doc/maze.1
+
+Or you can do this, if you installed the program:
+
+    $ man maze