README.md 1.36 KB
Newer Older
Guido Günther's avatar
Guido Günther committed
1
# Handy
Alexander Mikhaylenko's avatar
Alexander Mikhaylenko committed
2
3
[![Pipeline status](https://gitlab.gnome.org/GNOME/libhandy/badges/main/build.svg)](https://gitlab.gnome.org/GNOME/libhandy/commits/main)
[![Code coverage](https://gitlab.gnome.org/GNOME/libhandy/badges/main/coverage.svg)](https://gitlab.gnome.org/GNOME/libhandy/commits/main)
Guido Günther's avatar
Guido Günther committed
4

5
The aim of the Handy library is to help with developing UI for mobile devices
Oliver Galvin's avatar
Oliver Galvin committed
6
using GTK/GNOME.
Guido Günther's avatar
Guido Günther committed
7
8
9

## License

Guido Günther's avatar
Guido Günther committed
10
libhandy is licensed under the LGPL-2.1+.
Guido Günther's avatar
Guido Günther committed
11
12
13

## Building

14
We use the Meson (and thereby Ninja) build system for libhandy. The quickest
Guido Günther's avatar
Guido Günther committed
15
16
way to get going is to do the following:

17
18
19
20
21
```sh
meson . _build
ninja -C _build
ninja -C _build install
```
Guido Günther's avatar
Guido Günther committed
22

Guido Günther's avatar
Guido Günther committed
23
For build options see [meson_options.txt](./meson_options.txt). E.g. to enable documentation:
Guido Günther's avatar
Guido Günther committed
24

25
26
```sh
meson . _build -Dgtk_doc=true
27
ninja -C _build
28
```
Guido Günther's avatar
Guido Günther committed
29
30
31

## Usage

Guido Günther's avatar
Guido Günther committed
32
There's a C example:
Guido Günther's avatar
Guido Günther committed
33

34
35
36
```sh
_build/examples/example
```
Guido Günther's avatar
Guido Günther committed
37
38

and one in Python. When running from the built source tree it
louib's avatar
louib committed
39
needs several environment variables so use \_build/run to set them:
Guido Günther's avatar
Guido Günther committed
40

41
42
43
```sh
_build/run examples/example.py
```
44
45

### Glade
46

47
48
49
To be able to use Handy's widgets in the glade interface designer without
installing the library use:

50
51
52
```sh
_build/run glade
```
Guido Günther's avatar
Guido Günther committed
53
54
55
56

## Documentation

The documentation can be found online
57
[here](https://gnome.pages.gitlab.gnome.org/libhandy).
58
59
60
61

## Getting in touch

Matrix room: [#libhandy:talk.puri.sm](https://gnome.element.io/#/room/#libhandy:talk.puri.sm)