From 935b5b77204071be26b57c8fc189d3b9cc42dea7 Mon Sep 17 00:00:00 2001 From: unspeaker Date: Mon, 25 Nov 2024 19:09:59 +0100 Subject: [PATCH] add architecture diagram --- crates/tek_core/README.md | 37 ++------------------------------ crates/tek_core/architecture.svg | 4 ++++ 2 files changed, 6 insertions(+), 35 deletions(-) create mode 100644 crates/tek_core/architecture.svg diff --git a/crates/tek_core/README.md b/crates/tek_core/README.md index ac95ba2d..3a029c02 100644 --- a/crates/tek_core/README.md +++ b/crates/tek_core/README.md @@ -1,38 +1,5 @@ # `tek_core` -Core "utilities" module of Tek TUI DAW. +Core module of Tek TUI DAW. -## Exiting - -The `Exit` trait defines the API for exitable entities, -such as the main app or the modal dialogs. - -## Rendering output - -The `Render` trait... - -The `render!` macro for implementing the `Render` trait... - -The `render_thread` function for starting the render thread... - -The various layout and rendering helpers... - -## Handling input - -The `Handle` trait... - -The `handle!` macro... - -The `input_thread` function... - -## Running an app - -The `Component` trait... - -The `run` function... - -## Module helpers - -The `submod!` macro... - -The `pubmod!` macro... +![](./architecture.svg) diff --git a/crates/tek_core/architecture.svg b/crates/tek_core/architecture.svg new file mode 100644 index 00000000..706c2c75 --- /dev/null +++ b/crates/tek_core/architecture.svg @@ -0,0 +1,4 @@ + + + +
ratatui
ratatui
main()
main()
Engine
Engine
AppTui
(model)
AppTui...
render thread
(view)
render thread...
input thread
(controller)
input thread...
audio thread
(view/controller)
audio thread...
trait
Widget
trait...
Widget
Widget
Widget
Widget
Widget
Widget
Buffer
(display)
Buffer...
keyboard events
keyboard events
trait
InputToCommand
trait...
trait
Command
trait...
JACK
JACK
trait
Audio
trait...Text is not SVG - cannot display \ No newline at end of file