chris
/
jacket
1
1
Fork 0
Code Issues Pull Requests Releases Activity

docs: update readme and license year 

Signed-off-by: Christopher Arndt <chris@chrisarndt.de>
This commit is contained in:
Christopher Arndt 2023-05-24 09:48:15 +02:00
parent 75e1266da4
commit 1870734ae6
2 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
LICENSE
View File

@ -1,6 +1,6 @@
MIT License MIT License
Copyright (c) 2022 Christopher Arndt <info@chrisarndt.de> Copyright (c) 2022 - 2023 Christopher Arndt <info@chrisarndt.de>
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: 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:

13
README.md
View File

@ -7,10 +7,12 @@ A [Nim] wrapper for the [JACK] [C API]
This software is in *alpha status* and has no official release yet. This software is in *alpha status* and has no official release yet.
The basic JACK APIs (client lifecycle, ports, callbacks, MIDI, transport) have The majority of JACK client APIs have been wrapped and are functional (see
been wrapped and are functional (see [examples]), but latency, threading and [examples]), but some APIs (e.g. threading and ringbuffers) still need
meta-data APIs still need wrapping. Also, symbol names may still be changed wrapping. Others, like the server control or the deprecated session API, will
and things moved around before the first public release. 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 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 from Nim procs and types to C functions and types, probably in the form of
@ -24,7 +26,8 @@ JACK application.
* Clone this repository. * Clone this repository.
* Change into the `jacket` directory. * Change into the `jacket` directory.
* Run [`nimble install`] (or `nimble develop`). * Run [`nimble install`] (or `nimble develop`).
* Run the examples with `nim compile --run examples/<example>.nim`. * Run the examples with `nim compile --run examples/<example>.nim` (some also
need `--threads:on`).
## License ## License