[libchamplain] More README.md improvements
- From: Jiří Techet <jiritechet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libchamplain] More README.md improvements
- Date: Fri, 8 Feb 2019 16:19:49 +0000 (UTC)
commit 4d82f60d82d22ceea3ecb2ca722c84a433c964dd
Author: Jiří Techet <techet gmail com>
Date: Fri Feb 8 17:01:17 2019 +0100
More README.md improvements
Makefile.am | 1 +
README.md | 37 ++++++++++++++++++++-----------------
libchamplain.doap | 8 ++++----
3 files changed, 25 insertions(+), 21 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index b333b8a..b41439a 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -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 \
diff --git a/README.md b/README.md
index ecabe58..82745e6 100644
--- a/README.md
+++ b/README.md
@@ -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
diff --git a/libchamplain.doap b/libchamplain.doap
index 666df4c..9d9d408 100644
--- a/libchamplain.doap
+++ b/libchamplain.doap
@@ -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" />
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]