-QWeeChat authors
-================
+= QWeeChat authors
+Sébastien Helleu <flashcode@flashtux.org>
-Developers
-----------
-* General code
+== Developers
+* General code
** Sébastien Helleu (FlashCode) <flashcode@flashtux.org>
-
-Contributors
-------------
+== Contributors
Alphabetically:
* Gryllida A (gry)
* howaboutudance
-
-Contact
--------
+== Contact
Developers are connected to IRC:
* server: 'irc.freenode.net'
-* channels: '#weechat' (english) and '#weechat-fr' (french)
+* channels: '#weechat' (English) and '#weechat-fr' (French)
-QWeeChat installation
-=====================
+= QWeeChat installation
+Sébastien Helleu <flashcode@flashtux.org>
+
Required to run QWeeChat:
- Python 2.x >= 2.6
- PySide (recommended, packages: python.pyside.*) or PyQt4 (python-qt4)
-
-Run without install
--------------------
+== Run without install
Extract files from archive and run qweechat.py:
-----------------------------------------
+----
$ tar xvzf qweechat-x.y.tar.gz
$ cd qweechat-x.y
$ python src/qweechat/qweechat.py
-----------------------------------------
-
+----
-Run with install
-----------------
+== Run with install
Extract files from archive and install using script 'setup.py':
-----------------------------------------
+----
$ tar xvzf qweechat-x.y.tar.gz
$ cd qweechat-x.y
-----------------------------------------
+----
To install in your home:
-----------------------------------------
+----
$ python setup.py install --home=~/qweechat
-----------------------------------------
+----
To install in system directories (as root):
-----------------------------------------
+----
# python setup.py install
-----------------------------------------
+----
-
-WeeChat setup
--------------
+== WeeChat setup
You have to add a relay port in WeeChat, for example on port 1234:
-----------------------------------------
+----
/relay add weechat 1234
/set relay.network.password "mypass"
-----------------------------------------
-
+----
-Connect to WeeChat
-------------------
+== Connect to WeeChat
In QWeeChat, click on connect and enter fields:
-QWeeChat readme
-===============
+= QWeeChat readme
+Sébastien Helleu <flashcode@flashtux.org>
QWeeChat is a Qt remote GUI for WeeChat written in Python.
It requires WeeChat (version >= 0.3.7) on local or remote machine, with
relay plugin enabled and listening on a port with protocol "weechat".
+== Features
-Features
---------
-
-* multi-platform (GNU/Linux, *BSD, Mac OS X, QNX, Windows & other)
+* multi-platform (GNU/Linux, *BSD, Mac OS X, QNX, Windows & others)
* free software, released under GPLv3
-
-Copyright
----------
+== Copyright
Copyright (C) 2011-2013 Sébastien Helleu <flashcode@flashtux.org>