Skip to content

Commit

Permalink
Add docs for installing as a dep
Browse files Browse the repository at this point in the history
  • Loading branch information
sudara committed Dec 6, 2024
1 parent 03735cf commit 3a496de
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,24 @@ cmake -B Builds/Debug -DCMAKE_BUILD_TYPE=Debug . # configure
cmake --build Builds/Debug --config Debug # build
```

### Including within an existing JUCE project

Instead of running as a separate app, you can add pluginval as a CMake target to your existing plugin project. This not only makes for a convenient debugging workflow, it gives you better stack traces.

For example, if you add pluginval as a git submodule like so:
```
git submodule add -b develop [email protected]:Tracktion/pluginval.git modules/pluginval
```

or added with CPM like so:

```
CPMAddPackage("gh:tracktion/pluginval#develop")
```

Then all you need to do is call `add_subdirectory ("modules/pluginval")` in your `CMakeLists.txt`. This should be done **after** your call to `juce_add_plugin`.


### Third-party Installation
###### _Chocolatey (Windows):_
```shell
Expand Down

0 comments on commit 3a496de

Please sign in to comment.