aboutsummaryrefslogtreecommitdiffstats
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..89081a9
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,11 @@
+# Mandle
+This is an interactive mandlebrot viewer written in C11 and uses [SDL2](https://www.libsdl.org/) for rendering.
+
+## Build
+It needs [SDL2](https://www.libsdl.org/) and [meson](https://mesonbuild.com/) to build.
+
+```bash
+meson build
+ninja -C build
+ninja -C build install
+``` \ No newline at end of file