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

This commit is contained in:
Sebastien Helleu 2014-03-06 09:48:29 +01:00
parent 83dc503785
commit 6f4e0369d8
3 changed files with 97 additions and 91 deletions

60
INSTALL
View File

@ -1,60 +0,0 @@
= 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
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
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
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
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'.
See AUTHORS for support, feel free to contact us for any problem.

31
README
View File

@ -1,31 +0,0 @@
= 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/>.

97
README.asciidoc Normal file
View File

@ -0,0 +1,97 @@
= QWeeChat
:author: Sébastien Helleu
:email: flashcode@flashtux.org
:lang: en
QWeeChat is a Qt remote GUI for WeeChat written in Python.
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:
----
$ tar xvzf qweechat-x.y.tar.gz
$ cd qweechat-x.y
$ python src/qweechat/qweechat.py
----
=== 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
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
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/>.