aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9fd0ee2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# SchroederReverb
+A lightweight cross-platform VST3 reverb plugin written in C++ with the JUCE framework
+
+## Dependencies
+- [CMake](https://cmake.org)
+- pkg-config
+- [JUCE dependencies](https://github.com/juce-framework/JUCE/blob/cbe7eb9c5211784e903cfd62fef18531e6a88579/docs/Linux%20Dependencies.md) (on linux)
+
+## How to build this
+```bash
+git clone --recurse-submodules https://github.com/dkaisr/SchroederReverb.git
+cd SchroederReverb
+cmake -S . -B build
+cmake --build build
+```