From 1127b1ec097ad0bf113334de7761938173dceb68 Mon Sep 17 00:00:00 2001 From: Christopher Arndt Date: Mon, 10 Oct 2022 20:35:36 +0200 Subject: [PATCH] docs: add project status and installation sections to readme Signed-off-by: Christopher Arndt --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index bc0165a..e9baf31 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,38 @@ A [Nim] wrapper for the [JACK] [C API] +## Project status + +This software is in *alpha status* and has no official release yet. + +The basic JACK APIs (client lifecycle, ports, callbacks) have been wrapped and +are functional (see [examples]), but MIDI, transport and meta-data APIs still +need wrapping. Also, symbol names may still be changed and things moved around +before the first public release. + +Also, I plan to add a higher-level abstraction on top of the direct mapping +from Nim procs and types to C functions and types, probably in the form of +a JACk client object, which takes care of a JACK client instance, registering +ports and setting up all the callbacks necessary for a well-behaved JACK +application. + + +# Installation + +* Clone this repository. +* Change into the `jacket` directory. +* Run [`nimble install`] (or `nimble develop`). +* Run the examples with `nim compile --run examples/.nim`. + + ## License This software is released under the *MIT License*. See the [LICENSE](./LICENSE) file for more information. +[`nimble install`]: https://github.com/nim-lang/nimble#nimble-usage [C API]: https://jackaudio.org/api/ +[examples]: ./examples [JACK]: https://jackaudio.org/ [Nim]: https://nim-lang.org/