README.md

   1 Quassel IRC [![Linux Build Status](https://travis-ci.org/quassel/quassel.svg?branch=master)](https://travis-ci.org/quassel/quassel) [![Windows Build Status](https://ci.appveyor.com/api/projects/status/github/quassel/quassel?branch=master&svg=true)](https://ci.appveyor.com/project/quassel/quassel/branch/master)
   2 ===============
   3
   4 [Quassel IRC][web-home] is a modern, cross-platform, distributed IRC client,
   5 meaning that one (or multiple) client(s) can attach to and detach from a
   6 central core -- much like the popular combination of screen and a text-based
   7 IRC client such as WeeChat, but graphical.
   8
   9 Not only do we aim to bring a pleasurable, comfortable chatting experience to
  10 all major platforms, but it's free - as in beer and as in speech, since we
  11 distribute Quassel under [the GPL](https://www.gnu.org/licenses/gpl.html), and
  12 you are welcome to download and see for yourself!
  13
  14 ## Release notes
  15 You can find the current release notes on the [Quassel IRC homepage][web-home],
  16 as well as in this repository's [```ChangeLog```][repo-changelog].
  17
  18 ## Quick reference
  19
  20 On first run of the Quassel core, it will wait for a client to connect
  21 and present a first-run wizard that will allow you to create the database
  22 and one admin user for the core-side storage.
  23
  24 * To add more users, run: ```quasselcore --add-user```
  25 * To change the password of an existing user: ```quasselcore --change-userpass=username```
  26
  27 On some systems, you may need to specify ```--configdir```, e.g.
  28 ```quasselcore --configdir=/var/lib/quassel [command]```.
  29
  30 The ```manageusers.py``` script is deprecated and should no longer be used.
  31
  32 To learn more, see [the Quassel project wiki][docs-wiki] for in-depth
  33 documentation.
  34
  35 ## Getting involved
  36
  37 IRC is the preferred means of getting in touch with the developers.
  38
  39 The Quassel IRC Team can be contacted on **```Freenode/#quassel```**
  40 (or **```#quassel.de```**).  If you have trouble getting Quassel to connect,
  41 you can use [Freenode's webchat][help-freenode].
  42
  43 We always welcome new users in our channels!
  44
  45 You can learn more and reach out to us in several ways:
  46 * [Visit our homepage][web-home]
  47 * [Submit and browse issues on the bugtracker][dev-bugs]
  48  * Github issues are not used, but [pull requests][dev-pr-new] are accepted!
  49 * [Email the dev team - devel@quassel-irc.org][dev-email]
  50
  51 Thanks for reading,
  52
  53 ~ *The Quassel IRC Team*
  54
  55 [web-home]: http://quassel-irc.org
  56 [dev-bugs]: http://bugs.quassel-irc.org
  57 [dev-email]: mailto:devel@quassel-irc.org
  58 [dev-pr-new]: https://github.com/quassel/quassel/pull/new/master
  59 [docs-wiki]: http://bugs.quassel-irc.org/projects/quassel-irc/wiki
  60 [help-freenode]: https://webchat.freenode.net?channels=%23quassel
  61 [repo-changelog]: ChangeLog