move some docs to root

This commit is contained in:
🪞👃🪞 2024-12-30 21:56:52 +01:00
parent 5bc3517dde
commit 47c34d0077
4 changed files with 51 additions and 66 deletions

View file

@ -101,6 +101,57 @@ using `rustup` and the latter using `nix-shell`. From there, use the commands in
just arranger
```
## contents
This crate provides several musical utilities.
### `tek_sequencer`
A single-track, multi-pattern MIDI sequencer with properly tempo-synced pattern switch.
### `tek_groovebox`
A single-track, multi-pattern MIDI sequencer, attached to a sampler or plugin
(see `tek_plugin`).
### `tek_arranger`
A multi-track, multi-pattern MIDI sequencer translating the familiar clip launching workflow
into the TUI medium.
### `tek_transport`
Standalone JACK transport controller.
* Todo: bpm: shift +/- 0.001
* Todo: quant/sync: shift = next/prev value of same type (normal, triplet, dotted)
* Or: use shift to switch between inc/dec top/bottom value?
* Todo: focus play button
* Todo: focus time position
* Todo: edit numeric values
* Todo: jump to time/bbt markers
* Todo: count xruns
## `tek_sampler`
TODO: Standalone MIDI-controlled sampler.
## `tek_mixer`
TODO: Mixer.
- Meters: propagate clipping:
- If one stage clips, all stages after it are marked red
- If one track clips, all tracks that feed from it are marked red?
## `tek_track`
TODO: Channel strip.
## `tek_plugin`
TODO: Plugin host.
## usage
> [!WARNING]

View file

Before

(image error) Size: 25 KiB

After

(image error) Size: 25 KiB

View file

@ -1,65 +0,0 @@
# `tek`
This crate implements several musical utilities.
## `tek_sequencer`
A single-track, multi-pattern MIDI sequencer with properly tempo-synced pattern switch.
---
## `tek_arranger`
A multi-track, multi-pattern MIDI sequencer translating the familiar clip launching workflow
into the TUI medium.
---
## `tek_groovebox`
TODO: A single-track, multi-pattern MIDI sequencer,
attached to a sampler or plugin (see `tek_plugin`).
---
## `tek_timer`
TODO: This crate implements time sync and JACK transport control.
* Warning: If transport is set rolling by qjackctl, this program can't pause it
* Todo: bpm: shift +/- 0.001
* Todo: quant/sync: shift = next/prev value of same type (normal, triplet, dotted)
* Or: use shift to switch between inc/dec top/bottom value?
* Todo: focus play button
* Todo: focus time position
* Todo: edit numeric values
* Todo: jump to time/bbt markers
* Todo: count xruns
---
## `tek_mixer`
TODO:
// - Meters: propagate clipping:
// - If one stage clips, all stages after it are marked red
// - If one track clips, all tracks that feed from it are marked red?
---
## `tek_track`
TODO:
---
## `tek_sampler`
TODO: This crate implements a sampler device which plays audio files
in response to MIDI notes.
---
## `tek_plugin`
TODO:

View file

@ -1 +0,0 @@
mod sampler; pub(crate) use sampler::*;