Skip to content
Snippets Groups Projects
Commit 6f4e0369 authored by Sébastien Helleu's avatar Sébastien Helleu
Browse files

Remove INSTALL (merge into README), add screenshot in README

parent 83dc5037
No related branches found
No related tags found
No related merge requests found
= 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
* multi-platform (GNU/Linux, *BSD, Mac OS X, QNX, Windows & others)
* free software, released under GPLv3
== Copyright
Copyright (C) 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/>.
= QWeeChat installation
Sébastien Helleu <flashcode@flashtux.org>
= QWeeChat
:author: Sébastien Helleu
:email: flashcode@flashtux.org
:lang: en
 
 
Required to run QWeeChat:
- Python 2.x >= 2.6
- PySide (recommended, packages: python.pyside.*) or PyQt4 (python-qt4)
QWeeChat is a Qt remote GUI for WeeChat written in Python.
 
== Run without install
Homepage: http://weechat.org/
== Features
* Multi-platform (GNU/Linux, *BSD, Mac OS X, QNX, Windows & others).
* Free software, released under GPLv3.
image::http://static.weechat.org/images/screenshots/medium/qweechat.png[align="center"]
== 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)
=== Run without install
 
Extract files from archive and run qweechat.py:
 
Loading
Loading
@@ -16,7 +37,7 @@ $ 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':
 
Loading
Loading
@@ -42,8 +63,8 @@ To install in system directories (as root):
You have to add a relay port in WeeChat, for example on port 1234:
 
----
/relay add weechat 1234
/set relay.network.password "mypass"
/relay add weechat 1234
----
 
== Connect to WeeChat
Loading
Loading
@@ -56,5 +77,21 @@ In QWeeChat, click on connect and enter fields:
 
Options can be changed in file '~/.qweechat/qweechat.conf'.
 
== Copyright
Copyright (C) 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.
 
See AUTHORS for support, feel free to contact us for any problem.
You should have received a copy of the GNU General Public License
along with QWeeChat. If not, see <http://www.gnu.org/licenses/>.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment