summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNiels De Graef <nielsdegraef@gmail.com>2017-09-04 18:28:15 +0200
committerNiels De Graef <nielsdegraef@gmail.com>2017-09-04 18:28:15 +0200
commitcaec84e47a12c2304257929db65e6a5d6f50bba5 (patch)
tree9bb8f1fba76c82139864e5c29f04b65cfcb60ffc /README.md
parent5ea7c8a82fdc062ef9e4a2bcf4d745a0fce6a52a (diff)
downloadgnome-contacts-caec84e47a12c2304257929db65e6a5d6f50bba5.tar.gz
Update README for Meson & Contribution workflow
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 20 insertions, 3 deletions
diff --git a/README.md b/README.md
index e67fbe7..97fb5ef 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,20 @@
Contacts organizes your contacts information from all your online and offline
sources, providing a centralized place for managing your contacts.
-## Build
-Building Contacts can be done by executing these commands in the directory:
+## Building
+First download the source code from git:
```sh
git clone git://git.gnome.org/gnome-contacts
cd gnome-contacts
-./autogen.sh && make && make install
+```
+
+You can then build Contacts using either [Meson](http://mesonbuild.com/) or
+Autotools:
+```sh
+# Meson
+meson build && ninja -C build
+# Autotools
+./autogen.sh && make
```
## Issue tracker
@@ -20,6 +28,15 @@ an issue using the
In case of a bug, please also add reproducible steps and the version of Contacts.
+## Contributing
+If you would like to contribute a patch, you should send it in to the GNOME
+Bugzilla as well. If the patch fixes an existing bug, add the patch as an
+attachment to that bug report; otherwise, enter a new bug report that describes
+the patch, and attach the patch to that bug report.
+
+For more information on the recommended workflow, please read
+[this wiki page](https://wiki.gnome.org/Git/WorkingWithPatches).
+
## More information
Contacts has its own web page on https://wiki.gnome.org/Apps/Contacts.