From 9214958bd2ff34f76e419f3aeb22c11c4460804b Mon Sep 17 00:00:00 2001 From: unspeaker Date: Mon, 10 Mar 2025 12:16:46 +0200 Subject: [PATCH] add install from source instruction --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6d5f471a..18280e13 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,9 @@ or [**matrix** `@unspeaker:matrix.org`](https://matrix.to/#/@unspeaker:matrix.or ## usage +* **requirements:** linux; jack or pipewire; 24-bit terminal (i use `kitty`) +* **recommended:** midi controller; samples in wav format; lv2 plugins. + ``` Usage: tek [OPTIONS] @@ -65,8 +68,17 @@ Options: ## installation -* **requirements:** linux; jack or pipewire; 24-bit terminal (i use `kitty`) -* **recommended:** midi controller; samples in wav format; lv2 plugins. +### binary download + +see the [releases page](https://codeberg.org/unspeaker/tek/releases). + +### from source with cargo + +requires rust nightly. + +``` +cargo install --git https://codeberg.org/unspeaker/tek +``` ### arch linux @@ -77,11 +89,7 @@ you can install it using an AUR helper (e.g. `paru`): paru -S tek ``` -### downloads - -see the [releases page](https://codeberg.org/unspeaker/tek/releases). - -### building from source +## development you'll need a Rust toolchain and various system libraries.