-Quassel IRC [](https://travis-ci.org/quassel/quassel) [](https://ci.appveyor.com/project/quassel/quassel/branch/master)
+Quassel IRC
===============
+[![Linux Build Status][ci-linux-badge]][ci-linux-status-page] [![Windows Build Status][ci-win-badge]][ci-win-status-page]
+
[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
## 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].
+as well as in this repository's [`ChangeLog`][repo-changelog].
+
+## Downloading
+Official, stable downloads are provided on the [Quassel IRC download page][web-download].
+
+Automated Windows builds are available via the [AppVeyor build history][ci-win-status-history]. Pick a build, then choose the *Artifacts* tab.
+
+Unofficial builds and testing versions are [contributed by several community members][docs-wiki-unofficial-build].
## Quick reference
+We recommend reading the [getting started guide on the wiki][docs-wiki-getstart],
+but in a pinch, these steps will do.
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```
+and present a wizard that will allow you to create the database and one admin
+user for the core-side storage.
-On some systems, you may need to specify ```--configdir```, e.g.
-```quasselcore --configdir=/var/lib/quassel [command]```.
+Once you've set up Quassel, you may:
+* Add more users: `quasselcore --add-user`
+* Change the password of an existing user: `quasselcore --change-userpass=username`
+* See all available options: `quasselcore --help`
-The ```manageusers.py``` script is deprecated and should no longer be used.
+On some systems, you may need to specify `--configdir`, e.g.
+`quasselcore --configdir=/var/lib/quassel [command]`.
To learn more, see [the Quassel project wiki][docs-wiki] for in-depth
documentation.
IRC is the preferred means of getting in touch with the developers.
-The Quassel IRC Team can be contacted on **```Freenode/#quassel```**
-(or **```#quassel.de```**). If you have trouble getting Quassel to connect,
+The Quassel IRC Team can be contacted on **`Freenode/#quassel`**
+(or **`#quassel.de`**). 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!
+ * GitHub issues are not used, but [pull requests][dev-pr-new] are accepted!
* [Email the dev team - devel@quassel-irc.org][dev-email]
Thanks for reading,
~ *The Quassel IRC Team*
[web-home]: https://quassel-irc.org
+[web-download]: https://quassel-irc.org/downloads
[dev-bugs]: https://bugs.quassel-irc.org
[dev-email]: mailto:devel@quassel-irc.org
[dev-pr-new]: https://github.com/quassel/quassel/pull/new/master
[docs-wiki]: https://bugs.quassel-irc.org/projects/quassel-irc/wiki
+[docs-wiki-unofficial-build]: https://bugs.quassel-irc.org/projects/quassel-irc/wiki#Unofficial-builds
+[docs-wiki-getstart]: https://bugs.quassel-irc.org/projects/quassel-irc/wiki#Getting-started
[help-freenode]: https://webchat.freenode.net?channels=%23quassel
[repo-changelog]: ChangeLog
+[ci-linux-badge]: https://travis-ci.org/quassel/quassel.svg?branch=master
+[ci-linux-status-page]: https://travis-ci.org/quassel/quassel/branches
+[ci-win-badge]: https://ci.appveyor.com/api/projects/status/github/quassel/quassel?branch=master&svg=true&passingText=Windows:%20passing&pendingText=Windows:%20pending&failingText=Windows:%20failing
+[ci-win-status-page]: https://ci.appveyor.com/project/quassel/quassel/branch/master
+[ci-win-status-history]: https://ci.appveyor.com/project/quassel/quassel/history
projects / quassel.git / blobdiff