summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRoger <sachanroger@gmail.com>2019-09-02 16:14:24 +0000
committerNiels De Graef <nielsdegraef@gmail.com>2019-09-02 16:14:24 +0000
commit82c9796573bbd539c33afe1b59be0650f70c8de2 (patch)
tree67fe2a78c37f2cf37df68fdd89da011f90e72a4c /README.md
parentd1e6ad06d2a7620ddd98d50fa06154125a574c3f (diff)
downloadgnome-contacts-82c9796573bbd539c33afe1b59be0650f70c8de2.tar.gz
README formatting and add flatpak button
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index c8b6cce..02b6064 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,14 @@
# GNOME Contacts
+
Contacts organizes your contacts information from all your online and offline
sources, providing a centralized place for managing your contacts.
+[![Flatpak](https://upload.wikimedia.org/wikipedia/commons/thumb/a/a6/Flathub-badge-en.svg/240px-Flathub-badge-en.svg.png)](https://flathub.org/apps/details/org.gnome.Contacts)
+
## Building
+
You can build and install Contacts using [Meson](http://mesonbuild.com/):
+
```sh
meson build
ninja -C build
@@ -11,16 +16,19 @@ ninja -C build install
```
## Contributing
+
The code and issue tracker of Contacts can be found at the
[gnome-contacts repository](https://gitlab.gnome.org/GNOME/gnome-contacts) on
GNOME's GitLab instance.
### Reporting issues
+
If you find a bug in Contacts, please [file an
issue](https://gitlab.gnome.org/GNOME/gnome-contacts/issues) with reproducible
steps and the version of Contacts you were using at that point.
### Developers
+
If you want to contribute functionality or bug fixes to Contacts, you should
fork the Contacts repository, commit your changes, and then [open a merge
request](https://gitlab.gnome.org/GNOME/gnome-contacts/merge_requests/new) (MR).
@@ -28,6 +36,7 @@ If the MR fixes an existing issue, please refer to that issue in the
description of the commit.
### Translators
+
If GNOME Contacts is not translated in your language or you believe that the
current translation has errors, then you can join one of the various
translation teams in GNOME. Translators do not commit directly to Git, but are
@@ -36,7 +45,8 @@ be found at GNOME's Wiki page on the translation
project](https://wiki.gnome.org/TranslationProject/JoiningTranslation).
## More information
-Contacts has its own web page on https://wiki.gnome.org/Apps/Contacts.
+
+Contacts has its own web page on <https://wiki.gnome.org/Apps/Contacts>.
To discuss issues with developers and other users, you can subscribe to the
[mailing list](https://mail.gnome.org/mailman/listinfo/gnome-contacts-list)