README.md 1.82 KB
Newer Older
1 2
libchamplain - a map widget
===========================
3

4 5 6
libchamplain is a Gtk widget displaying zoomable and pannable maps that can be
loaded from various network sources. It supports overlay layers, markers, and
custom elements displayed on top of the maps. The library is written in C but
7
other language mappings are also available thanks to GObject-Introspection.
8

9
libchamplain depends on the following libraries:
10 11 12 13 14 15 16 17
* [glib](https://gitlab.gnome.org/GNOME/glib)
* [gtk](https://gitlab.gnome.org/GNOME/gtk)
* [clutter](https://gitlab.gnome.org/GNOME/clutter)
* [clutter-gtk](https://gitlab.gnome.org/GNOME/clutter-gtk)
* [libsoup](https://gitlab.gnome.org/GNOME/libsoup)
* [cairo](https://www.cairographics.org)
* [sqlite](https://www.sqlite.org)

18
To build libchamplain from sources using [meson](https://mesonbuild.com), run:
19
```
20
meson _builddir; cd _builddir; ninja; sudo ninja install
21 22
```

23 24 25 26 27 28
It is possible to specify compilation options defined in `meson_options.txt`
by using the `-D` flag, e.g.:
```
meson _builddir -Dgtk_doc=true -Ddemos=true
```

29
The **repository and bug report** page is at:
30
* https://gitlab.gnome.org/GNOME/libchamplain
31

32
Release **tarballs** can be downloaded from:
33
* https://download.gnome.org/sources/libchamplain
34

35
For simple examples how to use the library, check the `demos` directory;
36 37 38
in particular, the `minimal-gtk.c` and `minimal.py` demos are good starting
points to see how to get the most basic map application running.

39
Full **documentation** can be found at:
40
* https://gnome.pages.gitlab.gnome.org/libchamplain/champlain
41

42
The official **mailing list** is at:
43
* https://mail.gnome.org/mailman/listinfo/libchamplain-list
44

45
The official **IRC channel** is at:
46 47 48
* irc://irc.freenode.org/#champlain

---
49 50 51

libchamplain is licensed under the terms of the GNU Lesser General Public
License, version 2.1 or (at your option) later.