README.md
1LV2 Toolkit
2===========
3
4This software package contains libraries that wrap the LV2 C API and extensions
5into easy to use C++ classes.
6
7Status
8------
9[](https://travis-ci.org/lvtk/lvtk)
10
11Building
12--------
13To build and install, run
14```
15$ ./waf configure
16$ ./waf build
17$ sudo ./waf install
18```
19To build without the UIs, run
20
21`$ ./waf configure --disable-ui build`
22
23To build documentation, run
24
25`$ ./waf configure --docs build`
26
27HTML documentation gets placed in build/doc/html
28
29Packaging
30---------
31It is recommended for the 2.0 variety of LVTK to **completely replace** version 1.
32
33However, if v1 and v2 are to be installed on the same system, you will want to
34use the `--bundle` option in configure. This allows you to rename the `lvtk.lv2`
35bundle name so there aren't conflicts:
36```
37./waf configure --bundle=lvtk-2.lv2
38```
39
40ISC License
41-----------
42```
43Permission to use, copy, modify, and/or distribute this software for any
44purpose with or without fee is hereby granted, provided that the above
45copyright notice and this permission notice appear in all copies.
46
47THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
48WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
49MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
50ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
51WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
52ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
53OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
54```
55
56Issue Tracking
57--------------
58Please report bugs and feature requests here.
59https://github.com/lvtk/lvtk/issues
60
){kind=link}