Skip to content

Commit 8a330d4

Browse files
committed
Add docs for installing as a dep
1 parent f8a84a9 commit 8a330d4

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

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

31+
### Including within an existing JUCE project
32+
33+
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.
34+
35+
For example, if you add pluginval as a git submodule like so:
36+
```
37+
git submodule add -b develop [email protected]:Tracktion/pluginval.git modules/pluginval
38+
```
39+
40+
or added with CPM like so:
41+
42+
```
43+
CPMAddPackage("gh:tracktion/pluginval#develop")
44+
```
45+
46+
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`.
47+
48+
3149
### Third-party Installation
3250
###### _Chocolatey (Windows):_
3351
```shell

0 commit comments

Comments
 (0)