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 === Run without install
  31
  32 Extract files from archive and run qweechat.py:
  33
  34 ----
  35 $ tar xvzf qweechat-x.y.tar.gz
  36 $ cd qweechat-x.y
  37 $ python src/qweechat/qweechat.py
  38 ----
  39
  40 === Run with install
  41
  42 Extract files from archive and install using script 'setup.py':
  43
  44 ----
  45 $ tar xvzf qweechat-x.y.tar.gz
  46 $ cd qweechat-x.y
  47 ----
  48
  49 To install in your home:
  50
  51 ----
  52 $ python setup.py install --home=~/qweechat
  53 ----
  54
  55 To install in system directories (as root):
  56
  57 ----
  58 # python setup.py install
  59 ----
  60
  61 == WeeChat setup
  62
  63 You have to add a relay port in WeeChat, for example on port 1234:
  64
  65 ----
  66 /set relay.network.password "mypass"
  67 /relay add weechat 1234
  68 ----
  69
  70 == Connect to WeeChat
  71
  72 In QWeeChat, click on connect and enter fields:
  73
  74 * 'server': the IP address or hostname of your machine with WeeChat running
  75 * 'port': the relay port (defined in WeeChat)
  76 * 'password': the relay password (defined in WeeChat)
  77
  78 Options can be changed in file '~/.qweechat/qweechat.conf'.
  79
  80 == Copyright
  81
  82 Copyright (C) 2011-2014 Sébastien Helleu <flashcode@flashtux.org>
  83
  84 This file is part of QWeeChat, a Qt remote GUI for WeeChat.
  85
  86 QWeeChat is free software; you can redistribute it and/or modify
  87 it under the terms of the GNU General Public License as published by
  88 the Free Software Foundation; either version 3 of the License, or
  89 (at your option) any later version.
  90
  91 QWeeChat is distributed in the hope that it will be useful,
  92 but WITHOUT ANY WARRANTY; without even the implied warranty of
  93 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  94 GNU General Public License for more details.
  95
  96 You should have received a copy of the GNU General Public License
  97 along with QWeeChat.  If not, see <http://www.gnu.org/licenses/>.