diff --git a/README.md b/README.md index 63431a4..914bca3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,2 @@ # vizia-plug-book -Tutorial for creating a audio plugins using Vizia and Nih-Plug +Tutorial for creating a audio plugins using Nih-Plug and Vizia. diff --git a/book.toml b/book.toml index 16d0ea8..264dfe2 100644 --- a/book.toml +++ b/book.toml @@ -3,4 +3,4 @@ authors = ["George Atkinson"] language = "en" multilingual = false src = "src" -title = "Creating audio plugins with Vizia and Nih-Plug" +title = "Creating audio plugins with Nih-Plug and Vizia" diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 54f14d1..b6db637 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -1,4 +1,5 @@ # Summary -- [Setup](./setup.md) - +- [Getting started](./getting_started.md) + + diff --git a/src/gain.md b/src/gain.md new file mode 100644 index 0000000..9cee694 --- /dev/null +++ b/src/gain.md @@ -0,0 +1,5 @@ +# A Simple Gain Plugin + +The template used in the [getting started](./setup.md) chapter creates for us a simple gain plugin. In this chapter we'll add a knob to control the gain of the audio input, as well as a peek meter to visualize the audio level after the gain has been applied. + +## \ No newline at end of file diff --git a/src/setup.md b/src/getting_started.md similarity index 77% rename from src/setup.md rename to src/getting_started.md index 3c78e1e..d27b5b5 100644 --- a/src/setup.md +++ b/src/getting_started.md @@ -1,11 +1,10 @@ -# Chapter 1 - +# Getting Started ## Creating a new project using the template First, we'll use [cookicutter](https://github.com/cookiecutter/cookiecutter) to create a new nih-plug project using the [nih-plug template](https://github.com/robbert-vdh/nih-plug-template). -We can run the template generator using [pipx](https://pypa.github.io/pipx/) with the following in a directory of your choosing: +We can run the template generator using [pipx](https://pypa.github.io/pipx/) with the following: ``` pipx run cookiecutter gh:robbert-vdh/nih-plug-template @@ -19,13 +18,13 @@ The CLI tool will prompt you to enter a name for the plugin, in this case we've The template creates a nih-plug project without a GUI, so first we need to change the dependencies to include vizia into the project. -Open the `Cargo.toml` and add the following dependency below the `nih_plug` dependency: +Open the `Cargo.toml` file and add the following below the `nih_plug` dependency: ```toml nih_plug_vizia = { git = "https://github.com/robbert-vdh/nih-plug.git" } ``` -Note that the git URL is the same as the `nih_plug` dependency above it as the crates are from the same repository. +Note that the git URL is the same as the `nih_plug` dependency above it as both crates are from the same repository. ## Adding a basic Vizia GUI @@ -54,7 +53,7 @@ The `create_vizia_editor` function creates the vizia GUI window with a size dete Within the closure passed to the `create_vizia_editor` function is where we create the vizia GUI and add some controls. In this case we've added a simple label to begin with. -To actually add the GUI to the plugin we need to add an `editor` method to the `Plugin` trait implementation of `ViziaPlug`. Add the following to `lib.rs` below the `process` method: +To actually add the GUI to the plugin we need to add an `editor` method to the implementation of the`Plugin` trait for the `ViziaPlug` type. Add the following to the `lib.rs` file below the `process()` method: ```rust fn editor(&mut self, _async_executor: AsyncExecutor) -> Option> { @@ -62,7 +61,17 @@ fn editor(&mut self, _async_executor: AsyncExecutor) -> Option \ No newline at end of file + \ No newline at end of file diff --git a/src/logging_debugging.md b/src/logging_debugging.md index a967b29..8ae95af 100644 --- a/src/logging_debugging.md +++ b/src/logging_debugging.md @@ -2,4 +2,4 @@ ## Setting up logging -## Debugging with Bitwig \ No newline at end of file +## Debugging with a DAW \ No newline at end of file