aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHampus <hampus@hampusmat.com>2021-01-07 20:01:15 +0100
committerHampusM <hampus@hampusmat.com>2021-12-11 19:54:47 +0100
commit397cf44cc599430e8fe74b6daf59cfe02781081a (patch)
treefceb919b164e5448b8541e7d9a083d618c40f71f /README.md
parent425ed5ab81260bc04a94a55aa8373a19e7f19f50 (diff)
docs: add readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..19fb84c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+Mazerator
+=========
+A maze generator written in c
+
+Building
+--------
+It's simple. Just run
+
+ make
+
+Usage
+-----
+
+Run
+
+ ./mazerator
+
+You can get information about options and such by running
+
+ ./mazerator --help
+