README.md
1ZToolkit
2========
3
4[](https://builds.sr.ht/~alextee/ztoolkit?)
5
6ZToolkit (Ztk) is a cross-platform GUI toolkit
7heavily inspired by GTK.
8
9It handles events and low level drawing on
10behalf of the user and provides a high-level API
11for managing the UI and custom widgets.
12
13ZToolkit is written in C based on
14[pugl](https://drobilla.net/software/pugl) and was
15created to be used for various plugins bundled
16with the
17[Zrythm](https://www.zrythm.org) digital audio
18workstation.
19
20Dependencies
21------------
22Required: Cairo and X11
23
24Optional: Librsvg (for SVG support)
25
26Building
27--------
28
29 meson build -Denable_rsvg=true
30 ninja -C build
31 ninja -C build install
32
33Usage
34-----
35ZToolkit will install a static library that can be
36linked to. All of the API is exposed in a single
37header for convenience.
38
39 #include <ztoolkit/ztk.h>
40
41Docs are coming soon.
42
43Users
44-----
45[ZLFO](https://git.zrythm.org/cgit/ZLFO/) - a fully featured LFO for CV-based automation
46
47License
48-------
49ZToolkit is free software: you can redistribute it and/or modify
50it under the terms of the GNU Affero General Public License as
51published by the Free Software Foundation, either version 3 of the
52License, or (at your option) any later version.
53
54ZToolkit is distributed in the hope that it will be useful,
55but WITHOUT ANY WARRANTY; without even the implied warranty of
56MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
57GNU Affero General Public License for more details.
58
59The full text of the license can be found in the
60[COPYING](COPYING) file.
61
62For the copyright years, ZToolkit uses a range (“2008-2010”) instead of
63listing individual years (“2008, 2009, 2010”) if and only if every year
64in the range, inclusive, is a “copyrightable” year that would be listed
65individually.
66
67Some files, where specified, are licensed under
68different licenses.
69
70----
71
72Copyright (C) 2020 Alexandros Theodotou
73
74Copying and distribution of this file, with or without modification,
75are permitted in any medium without royalty provided the copyright
76notice and this notice are preserved. This file is offered as-is,
77without any warranty.
78
){kind=link}