aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6f3fbff
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# Cardioid
+
+Cardioid visualizer
+
+![recording](./recording.gif)
+
+# Usage
+
+- left/right arrow to decrese/increse the factor
+- up/down arrow to decrese/increse the number of points
+
+# Dependencies
+
+- [SDL2](https://libsdl.org)