From fc5853d8f72b165a3b32a6e1574e8ca1a2c95de2 Mon Sep 17 00:00:00 2001
From: Mike Oliphant <oliphant@nostatic.org>
Date: Thu, 9 Mar 2023 14:37:21 -0800
Subject: [PATCH] Added build instructions

---
 README.md | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e97eba7..03ed786 100644
--- a/README.md
+++ b/README.md
@@ -2,4 +2,32 @@
 
 Bare-bones implementation of [Neural Amp Modeler](https://github.com/sdatkinson/neural-amp-modeler) (NAM) models in an LV2 plugin.
 
-There is no user interface. Currently the model path is hardcoded in the plugin code.
+There is no user interface. Currently the model path is hardcoded in the plugin code [here](https://github.com/mikeoliphant/neural-amp-modeler-lv2/blob/main/src/nam_plugin.cpp). Yes, this is suboptimal, but it suffices for testing for now. I haven't yet found a way in LV2 to allow the user to select
+a file without doing a custom UI (which I don't really want to do).
+
+### Compiling
+
+First clone the repository:
+```bash
+git clone --recurse-submodules -j4 https://github.com/mikeoliphant/neural-amp-modeler-lv2
+cd neural-amp-modeler-lv2/build
+```
+
+Then compile the plugin using:
+
+**Linux/MacOS**
+```bash
+cmake .. -DCMAKE_BUILD_TYPE="Release"
+make -j4
+```
+
+**Windows**
+```bash
+cmake.exe -G "Visual Studio 17 2022" -A x64 ..
+cmake --build . --config=release -j4
+```
+
+Note - you'll have to change the Visual Studio version if you are using a different one.
+
+After building, the plugin will be in **build/neural_amp_modeler.lv2**.
+