Skip to content

Commit a66cdd4

Browse files
committed
Flesh out readme
Signed-off-by: Christopher Arndt <chris@chrisarndt.de>
1 parent cfbff83 commit a66cdd4

1 file changed

Lines changed: 72 additions & 0 deletions

File tree

README.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,73 @@
11
# pyjacklib
2+
3+
Python bindings for `libjack` using [ctypes], which allow you to write JACK
4+
client applications in Python.
5+
6+
The library provides a low-level, almost unaltered mapping of the `libjack`
7+
[C API], plus a few additional convenience functions.
8+
9+
10+
**Note:** **pyjacklib** *as a stand-alone project is in an early beta-stage and
11+
the API may still change slightly before a 1.0 release. You have been warned!*
12+
13+
14+
## Dependencies
15+
16+
To use the library, your system needs to have the following installed at
17+
run-time:
18+
19+
* The [JACK] library
20+
* A Python 3 implementation, which supports `ctypes`
21+
22+
To build and install the library you need:
23+
24+
* [setuptools]
25+
* (optional) [pip]
26+
27+
28+
## Building and Installing
29+
30+
You can download and install **pyjacklib** directly from PyPI using `pip`:
31+
32+
```con
33+
pip install pyjacklib
34+
```
35+
36+
Or you can download the latest source archive or clone the git repository
37+
and run the following from inside the unpacked source directory resp. the root
38+
of your checkout:
39+
40+
```con
41+
python setup.py install
42+
```
43+
44+
You can also build a wheel with:
45+
46+
```con
47+
pip wheel .
48+
```
49+
50+
... and install it using `pip install`.
51+
52+
53+
## License
54+
55+
**pyjacklib** is licensed under the GNU Public License Version v2, or
56+
any later version.
57+
58+
Please see the file [COPYING](./COPYING) for more information.
59+
60+
61+
## Authors
62+
63+
Created by *Filipe Coelho (falkTX)* as part of [Cadence].
64+
65+
Turned into stand-alone project and enhanced by *Christopher Arndt*.
66+
67+
68+
[C API]: https://jackaudio.org/api/
69+
[Cadence]: https://github.com/falkTX/Cadence.git
70+
[ctypes]: https://docs.python.org/3/library/ctypes.html
71+
[JACK]: https://jackaudio.org/
72+
[pip]: https://pypi.org/project/pip/
73+
[setuptools]: https://pypi.org/project/setuptools/

0 commit comments

Comments
 (0)