unspeaker/tek
1
0
Fork 0
mirror of https://codeberg.org/unspeaker/tek.git synced 2025-12-06 11:46:41 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

update outer README

Browse source
This commit is contained in:
🪞👃🪞 2024-12-25 06:23:08 +01:00
parent bac231b804
commit 8b498014d2
1 changed files with 40 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

70
README.md
View file

@ -1,32 +1,8 @@
# tek
[![Please don't upload to GitHub](https://nogithub.codeberg.page/badge.svg)](https://nogithub.codeberg.page)
# tek [![Please don't upload to GitHub](https://nogithub.codeberg.page/badge.svg)](https://nogithub.codeberg.page)
a music making program for your terminal
## project status
for roadmap, see https://codeberg.org/unspeaker/tek/milestones
> [!WARNING]
>
> As of 2024-10-25, I'm on track to release `tek 0.2.0` sometime in December 2024.
> I plan to tag the previous working prototype (as seen in the demos published in the
> [tek channel at basspistol's peertube](https://v.basspistol.org/c/tek/videos)) as `0.1.0`—
> once I've identified the appropriate commit!
>
> I've been dreaming of this project for a decade, and finally had the experience and peace of mind
> to start building it in late May 2024. I quickly reached the limit of how much of the UI I can
> write imperatively, so I started refactoring it in a more declarative style. The new interface
> logic is holding out pretty well, though it's not presently without its warts.
>
> Your moral support means a lot to me. Feel free to [contact me on Mastodon](https://mastodon.social/@unspeaker)!
> (Especially if you know how to host LV2 plugin UIs in `winit`; or how to relink abandoned Win32
> VST2s into LV2 or CLAP monoliths 😁)
>
> Love,
>
> (a rogue knowledge worker in a cyberpunk dystopia)
![Screenshot](https://codeberg.org/unspeaker/tek/attachments/549efab7-f46b-438b-9508-cd499d044b41)
## what it does
@ -34,6 +10,33 @@ Tek is a [MIDI](https://en.wikipedia.org/wiki/MIDI) sequencer, sampler, and plug
for the Linux terminal. It's written in [Rust](https://www.rust-lang.org/), and targets
[JACK](https://jackaudio.org/) (or [Pipewire](https://www.pipewire.org/)'s JACK implementation).
> [!NOTE]
>
> I've been dreaming of this project for a decade, and finally had the experience and peace of mind
> to start building it in late May 2024.
>
> I quickly reached the limit of how much of the UI I can write imperatively,
> so I started refactoring... and refactoring... and refactoring... you know
> how it is.
## project status
for roadmap, see https://codeberg.org/unspeaker/tek/milestones
> [!NOTE]
>
> As of 2024-12-25, the release window has been open since 2024-12-10.
> [6 alpha/beta versions have been published on the Releases page](https://codeberg.org/unspeaker/tek/releases).
> [!NOTE]
>
> I still want to tag the first working prototypes (as seen in the demos published in the
> [tek channel at basspistol's peertube](https://v.basspistol.org/c/tek/videos)) as `0.1.0`—
> once I've identified the appropriate commit!
[^0]: (Especially if you know how to host LV2 plugin UIs in `winit`;
or how to relink abandoned Win32 VST2s into LV2 or CLAP monoliths 😁)
## design goals
### lightweight
@ -76,10 +79,7 @@ looking for an excuse to embed a
### downloads
> [!WARNING]
>
> Binaries are currently unavailable. Right now your only option is to build from source.
> In the future I plan to integrate Forgejo Actions / Codeberg CI.
See the [releases page](https://codeberg.org/unspeaker/tek/releases).
### building from source
@ -114,3 +114,13 @@ Ardour, and probably others. The main view consists of three sections:
> Use `Tab` to switch focus between views. Use `Enter` to exclusively focus the highlighted view,
> and `Esc` to unfocus it. When a view is focused, use the `Arrow Keys` and `Enter` to navigate.
> Use `;` (semicolon) to open the command palette, which will list the remaining keybindings.
---
> [!NOTE]
> Your moral support means a lot to me.
> Feel free to [contact me on Mastodon](https://mastodon.social/@unspeaker)![^0]
>
> Love,
> 🤫
> (a rogue knowledge worker in a cyberpunk dystopia)