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

Rewrite README and make a README.md symlink to it for nice Gitlab formatting

parent 21e82147
Pipeline #57402 passed with stages
in 10 minutes and 50 seconds
libchamplain 0.12 README
=========================
========================
libchamplain is a Clutter based widget to display rich, eye-candy and
libchamplain is a Clutter based Gtk widget to display rich, eye-candy and
interactive maps.
libchamplain requires:
* glib >= 2.38
* gdk >= 3.0
* gtk >= 3.0
* clutter >= 1.24
* clutter-gtk >= 1.0
* cairo >= 1.4
* sqlite >= 3.0
* libsoup >= 2.42
If you are building libchamplain-gtk, you will also need:
* gtk >= 3.0
* clutter-gtk >= 1.0
If you are building libchamplain with local rendering support, you will
also need:
* libmemphis >= 0.2.1
To build using autotools, run:
```
./autogen.sh; make; sudo make install
```
The usual rules for building apply:
Alternatively, when using the meson build system, run:
```
meson _builddir; cd _builddir; ninja; sudo ninja install
```
./autogen.sh; make; sudo make install; sudo ldconfig
The repository and bug report page is at:
https://gitlab.gnome.org/GNOME/libchamplain
should do the right thing. For more details consult the INSTALL file in this
directory. Alternatively, using the meson build system, run
Release tarballs can be downloaded from:
https://download.gnome.org/sources/libchamplain/
meson _builddir; cd _builddir; ninja; sudo ninja install
For a simple examples how to use the library, check the `demos` directory;
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.
The official website is:
https://wiki.gnome.org/Projects/libchamplain
Full documentation can be found at:
https://gnome.pages.gitlab.gnome.org/libchamplain/champlain
https://gnome.pages.gitlab.gnome.org/libchamplain/champlain-gtk
The official mailing list archive is:
https://mail.gnome.org/mailman/listinfo/libchamplain-list
The official mailing list is at:
https://mail.gnome.org/mailman/listinfo/libchamplain-list
New bug page on GitLab:
https://gitlab.gnome.org/GNOME/libchamplain/issues
The official IRC channel is at:
irc://irc.freenode.org/#champlain
libchamplain is licensed under the terms of the GNU Lesser General Public
License, version 2.1 or (at your option) later.
README
\ No newline at end of file
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