aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCharles Cabergs <me@cacharle.xyz>2021-05-13 10:43:36 +0200
committerCharles Cabergs <me@cacharle.xyz>2021-05-13 10:43:36 +0200
commit660a556b7dd9b7a5cfb1f3e1e3a55a6975675f91 (patch)
treeeccad5697a2785c2bf0debbea610d8ab84ed003a /README.md
parentaf1d25613b7e1bace9ccabad1bcc9136d6417b07 (diff)
downloadfourier-series-viz-master.tar.gz
fourier-series-viz-master.tar.bz2
fourier-series-viz-master.zip
Added better viz, Added README and preview screenshotHEADmaster
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..ca9a11a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Fourier Series Visualization
+
+![preview](preview.png)
+
+## Usage
+
+```
+$ make
+$ ./fourier-series-viz
+```
+
+### Keybindings
+
+* `Esc`, `q`: quit
+* `j`/`k`, `-`/`=`: less/more circle
+* `p`, `Space`: pause
+
+### Dependencies
+
+* [SDL2](https://libsdl.org)
+* [SDL2\_gfx](https://www.ferzkopp.net/wordpress/2016/01/02/sdl_gfx-sdl2_gfx/)