Skip to content

Commit 6ab07f2

Browse files
Update README.md
1 parent 359f8eb commit 6ab07f2

1 file changed

Lines changed: 27 additions & 1 deletion

File tree

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,28 @@
11
# DCOffsetter
2-
DC offset audio plugin
2+
3+
DCOffsetter is an audio effect plugin that applies a variable DC offset to an audio signal.
4+
5+
![GUI snapshot](resource/snapshot.png "Plugin GUI")
6+
7+
This project utilizes Steinberg's [VST 3 SDK](https://github.com/steinbergmedia/vst3sdk) and [VSTGUI 4](https://github.com/steinbergmedia/vstgui).
8+
9+
## Installation
10+
11+
The pre-built plugin can be downloaded from the "Release" section. Execute the following steps if you want to build the project and plugin yourself (on Windows w/ Visual Studio):
12+
13+
1. Make sure that you have set up the VST 3 SDK, VSTGUI 4 and [CMake](https://cmake.org/).
14+
15+
2. Run the following commands to build the project:
16+
```shell
17+
mkdir build
18+
cd build
19+
cmake -G "Visual Studio 17 2022" -DVST3_SDK_ROOT=/path/to/VST_SDK/vst3sdk/ ..
20+
```
21+
22+
3. Run the following command to build the plugin:
23+
```shell
24+
cmake --build . --config Release
25+
```
26+
Alternatively, you can use Visual Studio to build a debug version, which enables the UI editor. The build outputs will be stored in `build/VST3/Debug` and `build/VST3/Release`.
27+
28+
4. To use the plugin in a host application, copy the .vst3 package to your VST3 folder.

0 commit comments

Comments
 (0)