Fancify README with Markdown, build status, links
authorShane Synan <>
Wed, 8 Jun 2016 17:57:51 +0000 (13:57 -0400)
committerManuel Nickschas <>
Wed, 28 Feb 2018 22:09:49 +0000 (23:09 +0100)
Transition README into Markdown formatting, still persisting the
ability to read it as plain-text, asides from the status badges.

Add AppVeyor and Travis CI status badges to the top of the page.  Not
only does this make it easier to access build history, it's a pretty
quick way to tell if the build is working or not.

Add a few more handy links to (hopefully) help those stumbling across
Quassel's dev repo without prior knowledge.

Closes GH-209.

(cherry picked from commit 6d191d78dfafd07daeb3b39e140677c10a1e4a6a)

README [deleted file] [new file with mode: 0644]

diff --git a/README b/README
deleted file mode 100644 (file)
index 1877b62..0000000
--- a/README
+++ /dev/null
@@ -1,23 +0,0 @@
-Quassel IRC - Release Notes
-Please find the current release notes at <>.
-On first run of the Quassel core, it will wait for a client to connect
-and present a first-run wizard that will allow you to create the database
-and one admin user for the core-side storage.
-To add more users, run: `quasselcore --add-user`
-To change the password of an existing user: `quasselcore --change-userpass=username`
-The script is deprecated.
-IRC is the preferred means of getting in touch with the developers.
-The Quassel IRC Team can be contacted on Freenode/#quassel (or  We always welcome new users in our channels!
-Our homepage is <>
-The bugtracker can be found at <>
-The dev team can be reached by email: <>
-Thanks for reading,
-~ The Quassel IRC Team
diff --git a/ b/
new file mode 100644 (file)
index 0000000..60a4532
--- /dev/null
+++ b/
@@ -0,0 +1,61 @@
+Quassel IRC [![Linux Build Status](]( [![Windows Build Status](](
+[Quassel IRC][web-home] is a modern, cross-platform, distributed IRC client,
+meaning that one (or multiple) client(s) can attach to and detach from a
+central core -- much like the popular combination of screen and a text-based
+IRC client such as WeeChat, but graphical.
+Not only do we aim to bring a pleasurable, comfortable chatting experience to
+all major platforms, but it's free - as in beer and as in speech, since we
+distribute Quassel under [the GPL](, and
+you are welcome to download and see for yourself!
+## Release notes
+You can find the current release notes on the [Quassel IRC homepage][web-home],
+as well as in this repository's [```ChangeLog```][repo-changelog].
+## Quick reference
+On first run of the Quassel core, it will wait for a client to connect
+and present a first-run wizard that will allow you to create the database
+and one admin user for the core-side storage.
+* To add more users, run: ```quasselcore --add-user```
+* To change the password of an existing user: ```quasselcore --change-userpass=username```
+On some systems, you may need to specify ```--configdir```, e.g.
+```quasselcore --configdir=/var/lib/quassel [command]```.
+The `````` script is deprecated and should no longer be used.
+To learn more, see [the Quassel project wiki][docs-wiki] for in-depth
+## Getting involved
+IRC is the preferred means of getting in touch with the developers.
+The Quassel IRC Team can be contacted on **```Freenode/#quassel```**
+(or **``````**).  If you have trouble getting Quassel to connect,
+you can use [Freenode's webchat][help-freenode].
+We always welcome new users in our channels!
+You can learn more and reach out to us in several ways:
+* [Visit our homepage][web-home]
+* [Submit and browse issues on the bugtracker][dev-bugs]
+ * Github issues are not used, but [pull requests][dev-pr-new] are accepted!
+* [Email the dev team -][dev-email]
+Thanks for reading,
+~ *The Quassel IRC Team*
+[repo-changelog]: ChangeLog