qweechat/README.asciidoc
Sébastien Helleu 77df9d06f7 Code refactoring, fix setup.py
All changes:
- full PEP8 compliance
- move sources from src/qweechat/ to qweechat/
- move data from data/icons/ to qweechat/data/icons/
- sources validated with PEP8
- use setuptools in setup.py, fix path of data files
2014-05-08 17:40:31 +02:00

1.9 KiB

QWeeChat

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

Features

  • Multi-platform (GNU/Linux, *BSD, Mac OS X, QNX, Windows & others).

  • Free software, released under GPLv3.

qweechat shadow

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)

Install via source distribution

$ python setup.py install

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:

  • '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)

Options can be changed in file '~/.qweechat/qweechat.conf'.

Copyright © 2011-2014 Sébastien Helleu <flashcode@flashtux.org>

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/.