|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | 03-May-2022 | - |
| doc/ | H | 03-May-2022 | - | 4,994 | 4,077 |
| lv2/ | H | 03-May-2022 | - | 16,048 | 10,716 |
| lv2specgen/ | H | 03-May-2022 | - | 8,502 | 5,199 |
| plugins/ | H | 03-May-2022 | - | 5,865 | 4,053 |
| resources/logo/ | H | 03-May-2022 | - | 588 | 586 |
| schemas.lv2/ | H | 03-May-2022 | - | 3,294 | 2,900 |
| util/ | H | 03-May-2022 | - | 112 | 107 |
| waflib/ | H | 03-May-2022 | - | 44,622 | 35,321 |
| .clang-tidy | H A D | 02-Jan-2021 | 606 | 22 | 21 |
| .gitlab-ci.yml | H A D | 19-Aug-2020 | 3.1 KiB | 157 | 121 |
| .gitmodules | H A D | 09-Feb-2020 | 70 | 4 | 3 |
| COPYING | H A D | 21-Apr-2019 | 846 | 17 | 13 |
| NEWS | H A D | 07-Jan-2021 | 11.5 KiB | 269 | 236 |
| README.md | H A D | 21-Apr-2019 | 2.2 KiB | 83 | 50 |
| lv2.pc.in | H A D | 21-Apr-2019 | 145 | 8 | 6 |
| waf | H A D | 28-Mar-2020 | 709 | 28 | 17 |
| wscript | H A D | 07-Jan-2021 | 29.4 KiB | 828 | 633 |
README.md
1LV2
2===
3
4LV2 is a plugin standard for audio systems. It defines a minimal yet extensible
5C API for plugin code and a format for plugin "bundles". See
6<http://lv2plug.in> for more information.
7
8This package contains specifications (C headers and Turtle files),
9documentation generation tools, and example plugins.
10
11Building and installation requires only Python 2.6. Building the documentation
12requires Doxygen.
13
14
15Installation
16------------
17
18A typical build looks something like this:
19
20 ./waf configure --prefix=/foo
21 ./waf
22 sudo ./waf install
23
24or, for packaging:
25
26 DESTDIR=/home/packager/lv2root ./waf install
27
28For help on the other available options, run:
29
30 ./waf --help
31
32The bundle installation directory can be set with the --lv2dir option, e.g.:
33
34 ./waf configure --lv2dir=/foo/lib/lv2
35
36Configuring with `--lv2-user` will install bundles to the user-local location.
37
38
39Packaging
40---------
41
42Specification bundles are both a build-time and run-time dependency of programs
43that use LV2. Programs expect their data to be available somewhere in
44`LV2_PATH`.
45
46See <http://lv2plug.in/pages/filesystem-hierarchy-standard.html> for details on
47the standard installation paths.
48
49Do not split up LV2 bundles, they are self-contained and must remain whole.
50Other than that, things may be split to suit distribution needs. For example,
51separate packages for specifications, tools, and plugins, may be good idea.
52
53
54Header Installation
55-------------------
56
57By default symbolic links to headers in bundles are installed to `INCLUDEDIR`.
58If symbolic links are a problem, configure with `--copy-headers` and copies
59will be installed instead.
60
61Headers are installed in two paths, the universal URI-based style:
62
63 #include "lv2/lv2plug.in/ns/ext/urid/urid.h"
64
65and the newer simple core style:
66
67 #include "lv2/urid/urid.h"
68
69Projects are encouraged to migrate to the latter style, though note that this
70style of include path may only be used by official LV2 specifications.
71
72
73Documentation
74-------------
75
76Configuring with the --docs option will build the documentation for all the
77included specifications if Doxygen is available. For example:
78
79 ./waf configure --docs
80 ./waf
81
82Specification documentation is also availabe online at <http://lv2plug.in/ns>.
83