docs: add project status and installation sections to readme
Signed-off-by: Christopher Arndt <chris@chrisarndt.de>
This commit is contained in:
parent
bffc611cdd
commit
1127b1ec09
26
README.md
26
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/<example>.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/
|
||||
|
|
Loading…
Reference in New Issue