README.md

   1 Quassel IRC
   2 ===============
   3
   4 [![Quassel CI Build Status][ci-badge]][ci-status-page]
   5
   6 [Quassel IRC][web-home] is a modern, cross-platform, distributed IRC client,
   7 meaning that one (or multiple) client(s) can attach to and detach from a
   8 central core -- much like the popular combination of screen and a text-based
   9 IRC client such as WeeChat, but graphical.
  10
  11 Not only do we aim to bring a pleasurable, comfortable chatting experience to
  12 all major platforms, but it's free - as in beer and as in speech, since we
  13 distribute Quassel under [the GPL](https://www.gnu.org/licenses/gpl.html), and
  14 you are welcome to download and see for yourself!
  15
  16 ## Release notes
  17 You can find the current release notes on the [Quassel IRC homepage][web-home],
  18 as well as in this repository's [`ChangeLog`][repo-changelog].
  19
  20 ## Downloading
  21 Official, stable downloads are provided on the [Quassel IRC download page](https://quassel-irc.org/downloads).
  22
  23 Automated Windows and macOS builds are available via the [GitHub Actions tab][ci-status-page].  Pick a build, then download the appropriate artifact.
  24
  25 *NOTE: As of this writing, you need to log into GitHub to download the automated builds.  This [issue is being tracked with GitHub](https://github.com/actions/upload-artifact/issues/51 ).*
  26
  27 Unofficial builds and testing versions are [contributed by several community members](https://bugs.quassel-irc.org/projects/quassel-irc/wiki#Unofficial-builds).
  28
  29 ## Quick reference
  30 We recommend reading the [getting started guide on the wiki](https://bugs.quassel-irc.org/projects/quassel-irc/wiki#Getting-started),
  31 but in a pinch, these steps will do.
  32
  33 On first run of the Quassel core, it will wait for a client to connect
  34 and present a wizard that will allow you to create the database and one admin
  35 user for the core-side storage.
  36
  37 Once you've set up Quassel, you may:
  38 * Add more users: `quasselcore --add-user`
  39 * Change the password of an existing user: `quasselcore --change-userpass=username`
  40 * See all available options: `quasselcore --help`
  41
  42 On some systems, you may need to specify `--configdir`, e.g.
  43 `quasselcore --configdir=/var/lib/quassel [command]`.
  44
  45 To learn more, see [the Quassel project wiki](https://bugs.quassel-irc.org/projects/quassel-irc/wiki) for in-depth
  46 documentation.
  47
  48 ## Getting involved
  49
  50 IRC is the preferred means of getting in touch with the developers.
  51
  52 The Quassel IRC Team can be contacted on **`Freenode/#quassel`**
  53 (or **`#quassel.de`**).  If you have trouble getting Quassel to connect,
  54 you can use [Freenode's webchat][help-freenode].
  55
  56 We always welcome new users in our channels!
  57
  58 You can learn more and reach out to us in several ways:
  59 * [Visit our homepage][web-home]
  60 * [Submit and browse issues on the bugtracker](https://bugs.quassel-irc.org)
  61   * GitHub issues are not used, but [pull requests](https://github.com/quassel/quassel/pull/new/master) are accepted!
  62 * [Email the dev team - devel@quassel-irc.org][dev-email]
  63
  64 Thanks for reading,
  65
  66 ~ *The Quassel IRC Team*
  67
  68 [web-home]: https://quassel-irc.org
  69 [dev-email]: mailto:devel@quassel-irc.org
  70 [help-freenode]: https://webchat.freenode.net?channels=%23quassel
  71 [repo-changelog]: ChangeLog
  72 [ci-badge]: https://github.com/quassel/quassel/workflows/Quassel%20CI/badge.svg?branch=master
  73 [ci-status-page]: https://github.com/quassel/quassel/actions?query=branch%3Amaster