added: manual

Cargo.toml

@@ -3,7 +3,7 @@ name = "clockwork"
 version = "0.1.0"
 edition = "2021"
 authors = ["Alexander Weichart <alexanderweichart@icloud.com>"]
-description = "VST plugin, which repeats actively played MIDI notes at variable speed. "
+description = "Simple MIDI note repeater."
 license = "GPL-3.0-or-later"
 
 [workspace]
@@ -29,6 +29,5 @@ nih_plug_egui = { git = "https://github.com/robbert-vdh/nih-plug.git" }
 # utility
 strum = "0.24"
 strum_macros = "0.24"
-ringbuf = "0.2.8"
 num-derive = "0.3"
 num-traits = "0.2"

README.md

@@ -1,22 +1,29 @@
-# ⏱️ Clockwork
+## ⏱️ Clockwork
 
-An audio plugin for repeating MIDI notes, written in Rust.
+An MIDI note repeater, written in Rust.
 
-## Showcase:
+### 🎬 Showcase:
+
+(turn on audio)
 
 https://user-images.githubusercontent.com/55558407/188208661-bbd208e8-f71d-4786-9e27-0cc5133f5c66.mp4
 
-## Manual:
+### 📖 Manual:
 
 The user manual can be found [here]().
 
-## Download
+### 💾 Download
 
 Clockwork is available as a VST3 and CLAP plugin:
 
 - [Clockwork.vst3]()
 - [Clockwork.clap]()
 
-## Development
+### 👨‍💻 Development
+
+This plugin is written in Rust, using:
+
+- [NIH-plug](https://github.com/robbert-vdh/nih-plug) as a plugin framework
+- [NIH-plug-egui](https://github.com/robbert-vdh/nih-plug/tree/master/nih_plug_egui) as a GUI framework
 
-If you want to contribute, or are simply interested in how the plugin is build, check out the [Dev-docs]()
+Contributions are welcome, please keep it simple and clean.

docs/manual.md

@@ -0,0 +1,41 @@
+## 📖 Clockwork Manual
+
+### Installation
+
+To install Clockwork, download either the VST3 or CLAP plugin:
+
+- [Clockwork.vst3]()
+- [Clockwork.clap]()
+
+After downloading, move the plugin to your VST3 or CLAP plugin folder and follow the instructions of your DAW to register it as a plugin.
+
+### Usage
+
+#### Setup
+
+Clockwork on itself does not produce any sound. It is a MIDI effect, which means that it can only take MIDI as an input and produce MIDI as an output.. 
+
+The setup differs depending on your DAW. However, you can simply follow the same steps as for any other MIDI effect plugin. 
+
+Here's an example for Cthulhu, which is also a MIDI effect plugin:
+
+- https://www.youtube.com/results?search_query=cthulhu+plugin+setup
+
+#### Controls
+
+##### Frequency
+
+- This slider controls, how fast the current note is repeated.
+
+##### Frequency Type
+
+- This button controls the type of the frequency.
+  - `Hz` means, that the frequency is measured in Hertz.
+  - `ms` means, that the frequency is measured in milliseconds.
+
+##### Trigger Type
+
+- This button controls, what happens when a new note is triggered.
+  - `Continue`: MIDI notes have no effect on the repetition loop
+  - `Re-trigger`: MIDI notes re-trigger the repetition loop
+  - `Re-trigger delayed`: MIDI notes re-trigger the repetition loop with an initial delay ( = frequency)

src/lib.rs

@@ -233,10 +233,9 @@ fn on_note_on (&mut self, note_event: NoteEvent) {
     }
 }
 
-// TODO: Configure this
 impl ClapPlugin for Clockwork {
     const CLAP_ID: &'static str = "com.alexanderweichart.clockwork";
-    const CLAP_DESCRIPTION: Option<&'static str> = Some("VST plugin, which repeats actively played MIDI notes at variable speed. ");
+    const CLAP_DESCRIPTION: Option<&'static str> = Some("Simple MIDI note repeater.");
     const CLAP_MANUAL_URL: Option<&'static str> = Some(Self::URL);
     const CLAP_SUPPORT_URL: Option<&'static str> = Some(Self::URL);