README.asciidoc

   1 = QWeeChat
   2 :author: Sébastien Helleu
   3 :email: flashcode@flashtux.org
   4 :lang: en
   5
   6
   7 QWeeChat is a Qt remote GUI for WeeChat written in Python.
   8
   9 Homepage: http://weechat.org/
  10
  11
  12 == Features
  13
  14 * Multi-platform (GNU/Linux, *BSD, Mac OS X, QNX, Windows & others).
  15 * Free software, released under GPLv3.
  16
  17 image::http://static.weechat.org/images/screenshots/medium/qweechat_shadow.png[align="center"]
  18
  19 == Install
  20
  21 === Dependencies
  22
  23 Following packages are *required*:
  24
  25 * WeeChat (version >= 0.3.7) on local or remote machine, with relay plugin
  26   enabled and listening on a port with protocol "weechat"
  27 * Python 2.x >= 2.6
  28 * PySide (recommended, packages: python.pyside.*) or PyQt4 (python-qt4)
  29
  30 === Install via source distribution
  31
  32 ----
  33 $ python setup.py install
  34 ----
  35
  36 == WeeChat setup
  37
  38 You have to add a relay port in WeeChat, for example on port 1234:
  39
  40 ----
  41 /set relay.network.password "mypass"
  42 /relay add weechat 1234
  43 ----
  44
  45 == Connect to WeeChat
  46
  47 In QWeeChat, click on connect and enter fields:
  48
  49 * 'server': the IP address or hostname of your machine with WeeChat running
  50 * 'port': the relay port (defined in WeeChat)
  51 * 'password': the relay password (defined in WeeChat)
  52
  53 Options can be changed in file '~/.qweechat/qweechat.conf'.
  54
  55 == Copyright
  56
  57 Copyright (C) 2011-2014 Sébastien Helleu <flashcode@flashtux.org>
  58
  59 This file is part of QWeeChat, a Qt remote GUI for WeeChat.
  60
  61 QWeeChat is free software; you can redistribute it and/or modify
  62 it under the terms of the GNU General Public License as published by
  63 the Free Software Foundation; either version 3 of the License, or
  64 (at your option) any later version.
  65
  66 QWeeChat is distributed in the hope that it will be useful,
  67 but WITHOUT ANY WARRANTY; without even the implied warranty of
  68 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  69 GNU General Public License for more details.
  70
  71 You should have received a copy of the GNU General Public License
  72 along with QWeeChat.  If not, see <http://www.gnu.org/licenses/>.