README

README.md

@@ -0,0 +1,27 @@
+# SquidgeSynth
+
+SquidgeSoft VST/CLAP audio plugin library, built with [DPF](https://github.com/DISTRHO/DFP) (DISTRHO Plugin Framework).
+
+## Prerequisites
+
+- **Compiler:** clang
+- **Build tools:** make, bear
+- **DPF:** Included as a submodule/subtree in `dpf/`
+
+## Build
+
+### Clone
+
+`git clone --recurse-submodules <repo>`
+
+If already cloned without submodules
+
+`git submodule update --init --recursive`
+
+### Compile
+
+`make plugins`
+
+### Verify
+
+`ls bin/`