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



commit 4cb936eb09323df596947dcfdcade96a1704a44b
Author: Jiří Techet <techet gmail com>
Date:   Fri Feb 8 12:35:51 2019 +0100

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

 README    | 50 ++++++++++++++++++++++++++------------------------
 README.md |  1 +
 2 files changed, 27 insertions(+), 24 deletions(-)
---
diff --git a/README b/README
index f4ee776..7acf032 100644
--- a/README
+++ b/README
@@ -1,45 +1,47 @@
 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.
diff --git a/README.md b/README.md
new file mode 120000
index 0000000..100b938
--- /dev/null
+++ b/README.md
@@ -0,0 +1 @@
+README
\ No newline at end of file


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]