From e7507b2dd0a027b020d97d3ea50e163380d7b934 Mon Sep 17 00:00:00 2001 From: Weird Constructor Date: Mon, 25 Jul 2022 05:09:06 +0200 Subject: [PATCH] Slight documentation improvement --- README.md | 8 +++++--- src/lib.rs | 8 +++++--- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 832e0ef..f25ae7b 100644 --- a/README.md +++ b/README.md @@ -101,9 +101,9 @@ This is a short overview of the API provided by the hexagonal Matrix API, which is the primary API used inside [HexoSynth](https://github.com/WeirdConstructor/HexoSynth). -This only showcases the non-realtime generation of audio -samples. For a real time application of this library please -refer to the examples that come with this library. +This only showcases the direct generation of audio samples, without any audio +device playing it. For a real time application of this library please refer to +the examples that come with this library. ```rust use hexodsp::*; @@ -131,6 +131,8 @@ let (out_l, out_r) = node_exec.test_run(0.11, true); // samples now. ``` +#### Simplified Hexagonal Matrix API + There is also a simplified version for easier setup of DSP chains on the hexagonal grid, using the [crate::MatrixCellChain] abstraction: diff --git a/src/lib.rs b/src/lib.rs index 034e480..6bf0243 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -103,9 +103,9 @@ This is a short overview of the API provided by the hexagonal Matrix API, which is the primary API used inside [HexoSynth](https://github.com/WeirdConstructor/HexoSynth). -This only showcases the non-realtime generation of audio -samples. For a real time application of this library please -refer to the examples that come with this library. +This only showcases the direct generation of audio samples, without any audio +device playing it. For a real time application of this library please refer to +the examples that come with this library. ```rust use hexodsp::*; @@ -133,6 +133,8 @@ let (out_l, out_r) = node_exec.test_run(0.11, true); // samples now. ``` +### Simplified Hexagonal Matrix API + There is also a simplified version for easier setup of DSP chains on the hexagonal grid, using the [crate::MatrixCellChain] abstraction: