[polari] Add a small README



commit 7df628dde8115871dfa6da9446e00da93dc303cc
Author: Florian Müllner <fmuellner gnome org>
Date:   Thu Nov 2 03:28:06 2017 +0100

    Add a small README
    
    On gitlab (or -hub), the file is displayed prominently on the project
    page, so put together some useful information for new contributors.

 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
---
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..99c735f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# ![polari-logo] Polari
+
+Polari is a simple Internet Relay Chat (IRC) client that is designed to
+integrate seamlessly with the GNOME desktop. You can find additional
+information on its [GNOME project page][project-page].
+
+## Hacking
+
+The easiest way to build the latest development version of Polari and
+start hacking on the code is to follow the recommended [GNOME guide]
+[build-instructions].
+
+## Getting in Touch
+
+Surprise, there is an IRC channel! If you have any questions regarding the
+use or development of Polari, want to discuss design or simply hang out
+with nice folks, please join us in [#polari on irc.gnome.org][irc-channel].
+
+## How to report bugs
+
+If you found a problem or have a feature suggestion, please report the
+issue to the GNOME [bug tracking system][bug-tracker].
+
+[project-page]: https://wiki.gnome.org/Apps/Polari
+[build-instructions]: https://wiki.gnome.org/Newcomers/BuildProject
+[irc-channel]: irc://irc.gnome.org/%23polari
+[bug-tracker]: https://gitlab.gnome.org/GNOME/polari/issues
+[polari-logo]: data/icons/hicolor/48x48/apps/org.gnome.Polari.png


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]