README.adoc 2.05 KB
Newer Older
1
2
3
4
5
6
= QWeeChat
:author: Sébastien Helleu
:email: flashcode@flashtux.org
:lang: en


7
8
image:https://travis-ci.org/weechat/qweechat.svg?branch=master["Build Status", link="https://travis-ci.org/weechat/qweechat"]

9
10
QWeeChat is a Qt remote GUI for WeeChat written in Python.

Sébastien Helleu's avatar
Sébastien Helleu committed
11
Homepage: https://weechat.org/
12
13
14
15
16
17

== Features

* Multi-platform (GNU/Linux, *BSD, Mac OS X, QNX, Windows & others).
* Free software, released under GPLv3.

18
image::https://weechat.org/media/images/screenshots/relay/medium/qweechat_shadow.png[align="center"]
19
20
21
22
23
24
25
26
27
28
29
30

== Install

=== Dependencies

Following packages are *required*:

* WeeChat (version >= 0.3.7) on local or remote machine, with relay plugin
  enabled and listening on a port with protocol "weechat"
* Python 2.x >= 2.6
* PySide (recommended, packages: python.pyside.*) or PyQt4 (python-qt4)

31
=== Install via source distribution
32
33

----
34
$ python setup.py install
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
----

== WeeChat setup

You have to add a relay port in WeeChat, for example on port 1234:

----
/set relay.network.password "mypass"
/relay add weechat 1234
----

== Connect to WeeChat

In QWeeChat, click on connect and enter fields:

Sébastien Helleu's avatar
Sébastien Helleu committed
50
51
52
* _server_: the IP address or hostname of your machine with WeeChat running
* _port_: the relay port (defined in WeeChat)
* _password_: the relay password (defined in WeeChat)
53

Sébastien Helleu's avatar
Sébastien Helleu committed
54
Options can be changed in file _~/.qweechat/qweechat.conf_.
55
56
57

== Copyright

Sébastien Helleu's avatar
Sébastien Helleu committed
58
Copyright (C) 2011-2018 Sébastien Helleu <flashcode@flashtux.org>
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

This file is part of QWeeChat, a Qt remote GUI for WeeChat.

QWeeChat is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.

QWeeChat is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with QWeeChat.  If not, see <http://www.gnu.org/licenses/>.