diff options
author | Bastien Nocera <hadess@hadess.net> | 2017-12-14 10:54:56 +0100 |
---|---|---|
committer | Bastien Nocera <hadess@hadess.net> | 2017-12-14 10:56:30 +0100 |
commit | 561b0f38081a67b7df2146b378304721e63f6ddb (patch) | |
tree | 064d261db4db90df34c835c91f6af78454ed6af4 /README.md | |
parent | 16b865f54e3a85d49b7ea8f64837d4aac1478724 (diff) | |
download | libgweather-561b0f38081a67b7df2146b378304721e63f6ddb.tar.gz |
README: Rename to README.md
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..dc83e48 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +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. + +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. + +You may download updates to the package from: + + http://download.gnome.org/sources/libgweather/ + +To discuss libgweather, you may use the desktop-devel-list mailing list: + + http://mail.gnome.org/mailman/listinfo/desktop-devel-list + + +Installation +============ + +See the file 'INSTALL'. If you are not using a released version of +libgweather (for example, if you checked out the code from git), you +first need to run './autogen.sh'. + + +How to report bugs +================== + +Bugs should be reported to the GNOME bug tracking system: + + https://bugzilla.gnome.org/ (product libgweather) + +You will 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. |