cmake: Build Windows icon resource again
[quassel.git] / README.md
1 Quassel IRC
2 ===============
3
4 [![Linux Build Status][ci-linux-badge]][ci-linux-status-page] [![Windows Build Status][ci-win-badge]][ci-win-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][web-download].
22
23 Automated Windows builds are available via the [AppVeyor build history][ci-win-status-history].  Pick a build, then choose the *Artifacts* tab.
24
25 Unofficial builds and testing versions are [contributed by several community members][docs-wiki-unofficial-build].
26
27 ## Quick reference
28 We recommend reading the [getting started guide on the wiki][docs-wiki-getstart],
29 but in a pinch, these steps will do.
30
31 On first run of the Quassel core, it will wait for a client to connect
32 and present a wizard that will allow you to create the database and one admin
33 user for the core-side storage.
34
35 Once you've set up Quassel, you may:
36 * Add more users: `quasselcore --add-user`
37 * Change the password of an existing user: `quasselcore --change-userpass=username`
38 * See all available options: `quasselcore --help`
39
40 On some systems, you may need to specify `--configdir`, e.g.
41 `quasselcore --configdir=/var/lib/quassel [command]`.
42
43 To learn more, see [the Quassel project wiki][docs-wiki] for in-depth
44 documentation.
45
46 ## Getting involved
47
48 IRC is the preferred means of getting in touch with the developers.
49
50 The Quassel IRC Team can be contacted on **`Freenode/#quassel`**
51 (or **`#quassel.de`**).  If you have trouble getting Quassel to connect,
52 you can use [Freenode's webchat][help-freenode].
53
54 We always welcome new users in our channels!
55
56 You can learn more and reach out to us in several ways:
57 * [Visit our homepage][web-home]
58 * [Submit and browse issues on the bugtracker][dev-bugs]
59   * GitHub issues are not used, but [pull requests][dev-pr-new] are accepted!
60 * [Email the dev team - devel@quassel-irc.org][dev-email]
61
62 Thanks for reading,
63
64 ~ *The Quassel IRC Team*
65
66 [web-home]: https://quassel-irc.org
67 [web-download]: https://quassel-irc.org/downloads
68 [dev-bugs]: https://bugs.quassel-irc.org
69 [dev-email]: mailto:devel@quassel-irc.org
70 [dev-pr-new]: https://github.com/quassel/quassel/pull/new/master
71 [docs-wiki]: https://bugs.quassel-irc.org/projects/quassel-irc/wiki
72 [docs-wiki-unofficial-build]: https://bugs.quassel-irc.org/projects/quassel-irc/wiki#Unofficial-builds
73 [docs-wiki-getstart]: https://bugs.quassel-irc.org/projects/quassel-irc/wiki#Getting-started
74 [help-freenode]: https://webchat.freenode.net?channels=%23quassel
75 [repo-changelog]: ChangeLog
76 [ci-linux-badge]: https://travis-ci.org/quassel/quassel.svg?branch=master
77 [ci-linux-status-page]: https://travis-ci.org/quassel/quassel/branches
78 [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
79 [ci-win-status-page]: https://ci.appveyor.com/project/quassel/quassel/branch/master
80 [ci-win-status-history]: https://ci.appveyor.com/project/quassel/quassel/history