summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonas Ådahl <jadahl@gmail.com>2020-10-23 20:43:40 +0200
committerJonas Ådahl <jadahl@gmail.com>2020-10-28 07:28:55 +0000
commit5ab187da701f2a8817fe47700c86bbae08daf4e5 (patch)
treedc2c72bfcef180f8bd1544f518d01aab30dbfaf9
parentc7a0ab3eb813dd78156434e492f1216766ec6c38 (diff)
downloadmutter-5ab187da701f2a8817fe47700c86bbae08daf4e5.tar.gz
README: Add link to wiki
The wiki has gotten a few pages recently, lets link to it. https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1521
-rw-r--r--README.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/README.md b/README.md
index 964b04d46..298fb87a6 100644
--- a/README.md
+++ b/README.md
@@ -26,11 +26,16 @@ debugging purposes.
To contribute, open merge requests at https://gitlab.gnome.org/GNOME/mutter.
+It can be useful to look at the documentation available at the
+[Wiki](https://gitlab.gnome.org/GNOME/mutter/-/wikis/home).
+
The coding style used is primarily the GNU flavor of the [GNOME coding
style](https://developer.gnome.org/programming-guidelines/stable/c-coding-style.html.en)
-with some minor additions such as preferring `stdint.h` types over GLib
-fundamental types, and a soft 80 character line limit. However, in general,
-look at the file you're editing for inspiration.
+with some minor additions such as preferring regular C types and
+`stdint.h` types over GLib fundamental types, except for gboolean, and
+guint/gulong for GSource ids and signal handler ids. There is also a soft
+80 character line limit. However, in general, look at the file you're
+editing for inspiration.
Commit messages should follow the [GNOME commit message
guidelines](https://wiki.gnome.org/Git/CommitMessages). We require an URL