2 :author: Sébastien Helleu
3 :email: flashcode@flashtux.org
7 QWeeChat is a Qt remote GUI for WeeChat written in Python.
9 Homepage: http://weechat.org/
11 image:https://travis-ci.org/weechat/qweechat.svg?branch=master["Build Status", link="https://travis-ci.org/weechat/qweechat"]
16 * Multi-platform (GNU/Linux, *BSD, Mac OS X, QNX, Windows & others).
17 * Free software, released under GPLv3.
19 image::http://static.weechat.org/images/screenshots/relay/medium/qweechat_shadow.png[align="center"]
25 Following packages are *required*:
27 * WeeChat (version >= 0.3.7) on local or remote machine, with relay plugin
28 enabled and listening on a port with protocol "weechat"
30 * PySide (recommended, packages: python.pyside.*) or PyQt4 (python-qt4)
32 === Install via source distribution
35 $ python setup.py install
40 You have to add a relay port in WeeChat, for example on port 1234:
43 /set relay.network.password "mypass"
44 /relay add weechat 1234
49 In QWeeChat, click on connect and enter fields:
51 * 'server': the IP address or hostname of your machine with WeeChat running
52 * 'port': the relay port (defined in WeeChat)
53 * 'password': the relay password (defined in WeeChat)
55 Options can be changed in file '~/.qweechat/qweechat.conf'.
59 Copyright (C) 2011-2014 Sébastien Helleu <flashcode@flashtux.org>
61 This file is part of QWeeChat, a Qt remote GUI for WeeChat.
63 QWeeChat is free software; you can redistribute it and/or modify
64 it under the terms of the GNU General Public License as published by
65 the Free Software Foundation; either version 3 of the License, or
66 (at your option) any later version.
68 QWeeChat is distributed in the hope that it will be useful,
69 but WITHOUT ANY WARRANTY; without even the implied warranty of
70 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
71 GNU General Public License for more details.
73 You should have received a copy of the GNU General Public License
74 along with QWeeChat. If not, see <http://www.gnu.org/licenses/>.