Add a README

1 files changed, 18 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fd2fa63
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# *CR*appy s*YNTH*
+Just a crappy synth using alsa and raylib. Works only on linux.
+
+## Building
+If you use nix, you can just run it like that:
+```sh
+nix run github:spl3g/crynth
+```
+
+For other systems you have to have these libraries:
+- raylib
+- asoundlib
+
+```sh
+cc -o nob nob.c
+./nob
+./build/crynth
+```