Commit 4d82f60d authored by Jiří Techet's avatar Jiří Techet

More README.md improvements

parent 92deb5f5
Pipeline #57471 passed with stages
in 14 minutes and 53 seconds
......@@ -17,6 +17,7 @@ pkgconfigdir = $(libdir)/pkgconfig
DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc --enable-gtk --enable-introspection --enable-vala-demos --disable-memphis
EXTRA_DIST = \
README.md \
champlain-gtk.pc.in \
champlain-gtk-uninstalled.pc.in \
champlain.pc.in \
......
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
......
......@@ -6,10 +6,10 @@
<name xml:lang="en">libchamplain</name>
<shortdesc xml:lang="en">A map widget</shortdesc>
<description>libchamplain is a Clutter based actor and a GTK widget displaying
interactive maps. Various map sources can be used together with the possibility
to draw custom overlays, markers and lines on top of the maps. Bindings to other
languages are provided using GObject Introspection.</description>
<description>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.</description>
<category rdf:resource="http://api.gnome.org/doap-extensions#core" />
<programming-language>C</programming-language>
<homepage rdf:resource="https://wiki.gnome.org/Projects/libchamplain" />
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment