From: Shane Synan Date: Wed, 8 Jun 2016 17:57:51 +0000 (-0400) Subject: Fancify README with Markdown, build status, links X-Git-Tag: 0.12.5~97 X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=commitdiff_plain;h=7e95ff801372a9707ecf9e7a32e74d7f5d55f118;hp=3ebdd7404e4e6504e875b3444f30297d63b8f33a Fancify README with Markdown, build status, links Transition README into Markdown formatting, still persisting the ability to read it as plain-text, asides from the status badges. Add AppVeyor and Travis CI status badges to the top of the page. Not only does this make it easier to access build history, it's a pretty quick way to tell if the build is working or not. Add a few more handy links to (hopefully) help those stumbling across Quassel's dev repo without prior knowledge. Closes GH-209. (cherry picked from commit 6d191d78dfafd07daeb3b39e140677c10a1e4a6a) --- diff --git a/README b/README deleted file mode 100644 index 1877b621..00000000 --- a/README +++ /dev/null @@ -1,23 +0,0 @@ -Quassel IRC - Release Notes -=========================== - -Please find the current release notes at . - -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` -The manageusers.py script is deprecated. - -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). We always welcome new users in our channels! - -Our homepage is -The bugtracker can be found at -The dev team can be reached by email: - -Thanks for reading, -~ The Quassel IRC Team diff --git a/README.md b/README.md new file mode 100644 index 00000000..60a45324 --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +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][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 +IRC client such as WeeChat, but graphical. + +Not only do we aim to bring a pleasurable, comfortable chatting experience to +all major platforms, but it's free - as in beer and as in speech, since we +distribute Quassel under [the GPL](https://www.gnu.org/licenses/gpl.html), and +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]. + +## Quick reference + +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``` + +On some systems, you may need to specify ```--configdir```, e.g. +```quasselcore --configdir=/var/lib/quassel [command]```. + +The ```manageusers.py``` script is deprecated and should no longer be used. + +To learn more, see [the Quassel project wiki][docs-wiki] for in-depth +documentation. + +## Getting involved + +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, +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! +* [Email the dev team - devel@quassel-irc.org][dev-email] + +Thanks for reading, + +~ *The Quassel IRC Team* + +[web-home]: http://quassel-irc.org +[dev-bugs]: http://bugs.quassel-irc.org +[dev-email]: mailto:devel@quassel-irc.org +[dev-pr-new]: https://github.com/quassel/quassel/pull/new/master +[docs-wiki]: http://bugs.quassel-irc.org/projects/quassel-irc/wiki +[help-freenode]: https://webchat.freenode.net?channels=%23quassel +[repo-changelog]: ChangeLog