diff options
| author | Jiří Techet <techet@gmail.com> | 2019-02-08 17:01:17 +0100 |
|---|---|---|
| committer | Jiří Techet <techet@gmail.com> | 2019-02-08 17:18:51 +0100 |
| commit | 4d82f60d82d22ceea3ecb2ca722c84a433c964dd (patch) | |
| tree | 261b79b5d47c65153e844b0343663c00bab45f7f /README.md | |
| parent | 92deb5f584509860d41ddf37b74e8bc2b9244498 (diff) | |
| download | libchamplain-4d82f60d82d22ceea3ecb2ca722c84a433c964dd.tar.gz | |
More README.md improvements
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 37 |
1 files changed, 20 insertions, 17 deletions
@@ -1,32 +1,35 @@ -libchamplain 0.12 README -======================== +libchamplain - a map widget +=========================== -libchamplain is a Gtk widget to display rich, eye-candy and interactive maps. +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 +other language mappings are also available thanks to GObject-introspection. libchamplain requires: - * [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) - -To build using autotools, run: +* [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) + +To build libchamplain from sources using meson, run: ``` -./autogen.sh; make; sudo make install +meson _builddir; cd _builddir; ninja; sudo ninja install ``` -Alternatively, when using the meson build system, run: +Alternatively, when using autotools, run: ``` -meson _builddir; cd _builddir; ninja; sudo ninja install +./autogen.sh; make; sudo make install ``` -The **repository** and **bug report** page is at: +The **repository and bug report** page is at: * https://gitlab.gnome.org/GNOME/libchamplain Release **tarballs** can be downloaded from: -* https://download.gnome.org/sources/libchamplain/ +* https://download.gnome.org/sources/libchamplain For simple examples how to use the library, check the `demos` directory; in particular, the `minimal-gtk.c` and `minimal.py` demos are good starting |