From b6d88e141e30938dde782eadb9ab8728ef0e315e Mon Sep 17 00:00:00 2001 From: kevin Date: Mon, 2 Dec 2024 12:14:25 -0500 Subject: [PATCH] README.md, examples/examples.md : Updates --- README.md | 7 ++++++- examples/examples.md | 12 ++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1bbfa63..6347fac 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # __caw__ audio processing program +__caw__ is a declarative language for describing real-time data flow programs +based on the [libcw](https://gitea.currawongproject.org/cml/libcw). + +The best introduction to the language is [__caw__ by Example](https://gitea.currawongproject.org/cml/caw/src/branch/master/examples/examples.md) +This tutorial steps through the basic language constructs and theory of operation. + # Installation @@ -25,7 +31,6 @@ git clone http://gitea.larke.org/kevin/caw.git cd caw/src git clone http://gitea.larke.org/kevin/libcw.git cd libcw -git switch poly ``` Debug Build diff --git a/examples/examples.md b/examples/examples.md index 36491f5..df1e018 100644 --- a/examples/examples.md +++ b/examples/examples.md @@ -1,5 +1,17 @@ ### Example 01 - Write a sine signal to an audio file. +__caw__ is a declarative language for describing data flow based +real-time audio signal processing programs. The language +is based on the __flow__ framework within [libcw](https://gitea.currawongproject.org/cml/libcw). + +Features of the language include: + +- Support for low-latency, interactive, real-time as well as non real-time programs. +- Easily described distributed, parallel processing. +- Clear and easily interpreted network execution semantics. +- Automatic user interface generation. +- Large collection of data flow unit processors. + __caw__ programs are described using a slightly extended form of JSON. In this example the program is contained in the dictionary labeled `sine_file_01` and