Skip to content

Commit 28a71d0

Browse files
committed
Add docs for installing as a dep
1 parent d507a4f commit 28a71d0

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,24 @@ cmake -B Builds/Debug -DCMAKE_BUILD_TYPE=Debug . # configure
3232
cmake --build Builds/Debug --config Debug # build
3333
```
3434

35+
### Including within an existing JUCE project
36+
37+
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.
38+
39+
For example, if you add pluginval as a git submodule like so:
40+
```
41+
git submodule add -b develop git@github.com:Tracktion/pluginval.git modules/pluginval
42+
```
43+
44+
or added with CPM like so:
45+
46+
```
47+
CPMAddPackage("gh:tracktion/pluginval#develop")
48+
```
49+
50+
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`.
51+
52+
3553
### Third-party Installation
3654
###### _Chocolatey (Windows):_
3755
```shell

0 commit comments

Comments
 (0)