summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBastien Nocera <hadess@hadess.net>2018-03-09 12:37:34 +0100
committerBastien Nocera <hadess@hadess.net>2018-03-09 12:43:10 +0100
commita95f8b748a58c044280627ae3be411ffddfce481 (patch)
treee8f3fe3644653efd85709d204b87582215c1b12a
parent97ecaebf9a88419887118e0aceed0d415324b2c8 (diff)
downloadlibgweather-a95f8b748a58c044280627ae3be411ffddfce481.tar.gz
README: Update to latest resources
Point to gitlab for new issues, wiki for how to contribute to the locations file, and developer.gnome.org for the API docs.
-rw-r--r--README.md21
1 files changed, 13 insertions, 8 deletions
diff --git a/README.md b/README.md
index 6b2f72d..d9837af 100644
--- a/README.md
+++ b/README.md
@@ -12,10 +12,11 @@ should feel free to use libgweather as users can always recompile against
a new version.
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.
+`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.
+Documentation for the API is available with gtk-doc, and online:
+ https://developer.gnome.org/libgweather/stable/
You may download updates to the package from:
@@ -29,15 +30,19 @@ To discuss libgweather, you may use the desktop-devel-list mailing list:
How to report bugs
==================
-Bugs should be reported to the GNOME bug tracking system:
+Bugs should be reported to the libgweather issues tracking system:
- https://bugzilla.gnome.org/ (product libgweather)
+ https://gitlab.gnome.org/GNOME/libgweather/issues
-You will need to create an account for yourself.
+You might need to create an account for yourself.
Please read the following page on how to prepare a useful bug report:
https://bugzilla.gnome.org/page.cgi?id=bug-writing.html
-Please read the HACKING file for information on where to send changes or
-bugfixes for this package.
+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.