[libgweather/ebassi/gtk4: 5/5] docs: Update the README file
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgweather/ebassi/gtk4: 5/5] docs: Update the README file
- Date: Wed, 13 Oct 2021 12:04:02 +0000 (UTC)
commit 7d98cfadae351d298d5f69d43d142c9da4ea7622
Author: Emmanuele Bassi <ebassi gnome org>
Date: Wed Oct 13 12:50:53 2021 +0100
docs: Update the README file
Update the links and various other details.
README.md | 22 +++++++---------------
1 file changed, 7 insertions(+), 15 deletions(-)
---
diff --git a/README.md b/README.md
index 7ecbd917..7b54a325 100644
--- a/README.md
+++ b/README.md
@@ -6,26 +6,17 @@ libgweather
libgweather is a library to access weather information from online
services for numerous locations.
-libgweather isn't supported in the devel platform, which means OS vendors
-won't guarantee the API/ABI long-term, but authors of open source apps
-should feel free to use libgweather as users can always recompile against
-a new version.
+Documentation for the API is available online at:
-To use libgweather in your code, you need to define the
-`GWEATHER_I_KNOW_THIS_IS_UNSTABLE` preprecessor symbol, e.g. by adding
-`-DGWEATHER_I_KNOW_THIS_IS_UNSTABLE` to your `CFLAGS`.
-
-Documentation for the API is available with gtk-doc, and online:
- https://developer.gnome.org/libgweather/stable/
+ https://gnome.pages.gitlab.gnome.org/libgweather/
You may download updates to the package from:
https://download.gnome.org/sources/libgweather/
-To discuss libgweather, you may use the desktop-devel-list mailing list:
-
- https://mail.gnome.org/mailman/listinfo/desktop-devel-list
+To discuss libgweather, you may use the "gweather" tag in Discourse:
+ https://discourse.gnome.org/tag/gweather
How to report bugs
==================
@@ -42,7 +33,8 @@ Please read the following page on how to prepare a useful bug report:
If you are interested in adding new locations (weather stations, or
cities), please refer to this page in the GNOME Wiki:
+
https://wiki.gnome.org/Projects/LibGWeather/ImprovingLocations
-Please read the HACKING file for information on the internal architecture
-of libgweather.
+Please read the [contribution guide](./CONTRIBUTING.md) for information on
+how to contribute to the project.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]