From 1870734ae683bd6a10d154ce457436b0deddeec5 Mon Sep 17 00:00:00 2001 From: Christopher Arndt Date: Wed, 24 May 2023 09:48:15 +0200 Subject: [PATCH] docs: update readme and license year Signed-off-by: Christopher Arndt --- LICENSE | 2 +- README.md | 13 ++++++++----- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/LICENSE b/LICENSE index e9dbb99..69b7c1a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 Christopher Arndt +Copyright (c) 2022 - 2023 Christopher Arndt Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: diff --git a/README.md b/README.md index 43826d3..6d7a825 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,12 @@ A [Nim] wrapper for the [JACK] [C API] This software is in *alpha status* and has no official release yet. -The basic JACK APIs (client lifecycle, ports, callbacks, MIDI, transport) have -been wrapped and are functional (see [examples]), but latency, threading and -meta-data APIs still need wrapping. Also, symbol names may still be changed -and things moved around before the first public release. +The majority of JACK client APIs have been wrapped and are functional (see +[examples]), but some APIs (e.g. threading and ringbuffers) still need +wrapping. Others, like the server control or the deprecated session API, will +probably not covered by these bindings. While this project is in alpha or beta +stage, 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 @@ -24,7 +26,8 @@ JACK application. * Clone this repository. * Change into the `jacket` directory. * Run [`nimble install`] (or `nimble develop`). -* Run the examples with `nim compile --run examples/.nim`. +* Run the examples with `nim compile --run examples/.nim` (some also + need `--threads:on`). ## License