summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNiels De Graef <nielsdegraef@gmail.com>2021-11-16 21:22:01 +0100
committerNiels De Graef <nielsdegraef@gmail.com>2022-06-28 14:23:30 +0200
commitdc29e40849f1adf2010cfc35f40a5efa738cbf6d (patch)
treeae9781f8df0d474bdf64ab9a69e7e7e0bb8286f2
parent280bc17b624e56e6163f563eee0eaa9d7fc6732b (diff)
downloadgcr-dc29e40849f1adf2010cfc35f40a5efa738cbf6d.tar.gz
README: mention the documentation
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 842b217..7013994 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,16 @@ https://gitlab.gnome.org/GNOME/gcr.
If you would like to get involved with GNOME projects, please also visit our
[Newcomers page] on the Wiki.
+Documentation
+-------------
+The documentation for GCR and GCK is built using [gi-docgen].
+
+You can find the nightly documentation at:
+
+* Gck: https://gnome.pages.gitlab.gnome.org/gcr/gck-1/
+* Gcr: https://gnome.pages.gitlab.gnome.org/gcr/gcr-3/
+* GcrUI: https://gnome.pages.gitlab.gnome.org/gcr/gcr-ui-3/
+
Debug tracing
-------------
The Gcr and Gck libraries contain statements which help debug flow
@@ -56,5 +66,6 @@ To discuss issues with developers and other users, you can post to the
+[gi-docgen]: https://gnome.pages.gitlab.gnome.org/gi-docgen/
[Meson]: https://mesonbuild.com
[Newcomers page]: https://wiki.gnome.org/TranslationProject/JoiningTranslation