Skip to content

Commit 73d64f1

Browse files
committed
update documentation
1 parent f4f9f9c commit 73d64f1

File tree

1 file changed

+50
-46
lines changed

1 file changed

+50
-46
lines changed

doc/Geonkick_User_Guide.md

Lines changed: 50 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,45 @@
1+
## Table of Contents
2+
3+
1. [Introduction](#introduction)
4+
2. [The Sound Designer Craft](#the-sound-designer-craft)
5+
3. [How it works](#how-it-works)
6+
4. [Block Diagram](#block-diagram)
7+
5. [Instrument](#instrument)
8+
- [Instrument Layers](#instrument-layers)
9+
- [Playing Instrument and Note off](#playing-instrument-and-note-off)
10+
- [Instrument UI](#instrument-ui)
11+
- [Top Bar](#top-bar)
12+
- [Shortcut Keys](#shortcut-keys)
13+
- [Instrument Envelope Area](#instrument-envelope-area)
14+
- [Envelope Points](#envelope-points)
15+
- [Bézier Curve for Envelopes](#bézier-curve-for-envelopes)
16+
- [Envelope Point Label](#envelope-point-label)
17+
- [Manually Input Envelope Point Value](#manually-input-envelope-point-value)
18+
- [Display Current Selected Coordinates of Envelope Point](#display-current-selected-coordinates-of-envelope-point)
19+
- [Instrument Wave Form](#instrument-wave-form)
20+
- [Instrument Preset](#instrument-preset)
21+
6. [Oscillator](#oscillator)
22+
7. [Global Controls](#global-controls)
23+
8. [Limiter](#limiter)
24+
9. [Filter](#filter)
25+
10. [Distortion](#distortion)
26+
11. [Tune](#tune)
27+
12. [Kit](#kit)
28+
- [Default Kit State](#default-kit-state)
29+
- [Kit UI](#kit-ui)
30+
- [Current Instrument](#current-instrument)
31+
- [Kit Output Channels](#kit-output-channels)
32+
- [Instrument vs Channel](#instrument-vs-channel)
33+
13. [Geonkick Preset](#geonkick-preset)
34+
14. [Sidebar](#sidebar)
35+
- [Preset Browser](#preset-browser)
36+
- [Sample Browser](#sample-browser)
37+
- [Export](#export)
38+
15. [Settings](#settings)
39+
16. [LV2 Plugin](#lv2-plugin)
40+
17. [Standalone](#standalone)
41+
18. [Build & Install](#build--install)
42+
143
# Geonkick User Guide
244

345
**Author:** Iurie Nistor
@@ -8,51 +50,7 @@
850

951
**Website:** [https://geonkick.org](https://geonkick.org)
1052

11-
### Table of Contents
12-
13-
- [Introduction](#introduction)
14-
- [The Sound Designer Craft](#the-sound-designer-craft)
15-
- [How it works](#how-it-works)
16-
- [Block diagram](#block-diagram)
17-
- [Instrument](#instrument)
18-
* [Instrument Layers](#instrument-layers)
19-
* [Playing Instrument and Note Off](#playing-instrument-and-note-off)
20-
* [Instrument UI](#instrument-ui)
21-
* [Top Bar](#top-bar)
22-
* [Shortcut Keys](#shortcut-keys)
23-
* [Instrument Envelope Area](#instrument-envelope-area)
24-
* [Envelope Points](#envelope-points)
25-
* [Envelope Point Label](#envelope-point-label)
26-
* [Manually Input Envelope Point Value](#manually-input-envelope-point-value)
27-
* [Display Current Selected Coordinates of Envelope Point](#display-current-selected-coordinates-of-envelope-point)
28-
* [Instrument Wave Form](#instrument-wave-form)
29-
* [Instrument Preset](#instrument-preset)
30-
* [Oscillator](#oscillator)
31-
* [Noise Generator](#noise-generator)
32-
* [General Controls](#general-controls)
33-
* [Limiter](#limiter)
34-
* [Filter](#filter)
35-
* [Distortion](#distortion)
36-
* [Compressor](#compressor)
37-
* [Tune](#tune)
38-
* [Export](#export)
39-
- [Kit](#kit)
40-
* [Default Kit State](#default-kit-state)
41-
* [Kit UI](#kit-ui)
42-
* [Current Instrument](#current-instrument)
43-
* [Kit Output Channels](#kit-output-channels)
44-
* [Kit Preset vs Instrument Preset](#kit-preset-vs-instrument-preset)
45-
- [Geonkick Preset](#geonkick-preset)
46-
- [Preset Browser](#preset-browser)
47-
- [Instrument vs Channel](#instrument-vs-channel)
48-
- [Sidebar](#sidebar)
49-
* [Preset Browser](#preset-browser)
50-
* [Sample Browser](#sample-browser)
51-
* [Export](#export)
52-
- [Settings](#settings)
53-
- [LV2 Plugin](#lv2-plugin)
54-
- [Standalone](#standalone)
55-
- [Build & Install](#build-install)
53+
5654

5755
### Introduction
5856

@@ -153,6 +151,12 @@ Users can add, remove, or move an envelope point. The default first and last poi
153151
- **Left double click:** Add a new point.
154152
- **Right click:** Remove the point.
155153

154+
#### Bézier Curve for Envelopes
155+
156+
To add a Bézier curve, you need to insert a control point between two node points using Left Ctrl + double-click.
157+
158+
Note: If one of the adjacent points is already a control point, a normal node point will be added instead. You can only add a control point between two existing node points.
159+
156160
#### Envelope Point Label
157161

158162
Envelope points have labels showing the current value related to vertical axes (amplitude, frequency, etc.). For frequency envelope or cutoff, an additional point label maps the current frequency to a MIDI note.
@@ -295,7 +299,7 @@ Geonkick is a preset in JSON format with the file extension "*.gkit" and include
295299

296300
### Sidebar
297301

298-
The sidebar contains the **Preset Browser** and **Sample Browser**. It can be shown or hidden from the settings, and this applies to all Geonkick instances.
302+
The sidebar contains the **Preset Browser** and **Sample Browser**. It can be shown or hidden from the settings, and this applies to all Geonkick instances.
299303
Use the top menu of the sidebar to switch between the **Preset Browser** and **Sample Browser**.
300304

301305
Both the Preset and Sample browsers have a top menu with the following controls:

0 commit comments

Comments
 (0)