X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=README.md;h=c7b03dc22f8bb6051f75a07c001335585c70c1fd;hp=2c4671876e057dea9b170b592d2c9dadbfa11e18;hb=8c6448c2e0048389fbac9e2e9daf22b5b050d5b6;hpb=c2e3479b87e7d0713d302d26fb2d7d01d7b8c9c2 diff --git a/README.md b/README.md index 2c467187..c7b03dc2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ -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) +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 @@ -13,21 +15,30 @@ 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]. +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. @@ -36,8 +47,8 @@ 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! @@ -45,7 +56,7 @@ 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, @@ -53,9 +64,17 @@ 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