Add entry "Save connection" in File menu

[irc/weechat/qweechat.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index e4b10137a1b421c05dc7469ad46a9a7c02ad45be..79700ad23eee0b1c0797a99dbe6b1cd1b7f4abd7 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -2,8 +2,8 @@ QWeeChat installation
 =====================
 
 Required to run QWeeChat:
-- python 2.x >= 2.6
-- PyQt4 (python-qt4) or PySide (python.pyside.*)
+- Python 2.x >= 2.6
+- PySide (recommended, packages: python.pyside.*) or PyQt4 (python-qt4)
 
 
 Run without install
@@ -11,19 +11,57 @@ 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/weechat.py
+$ python src/qweechat/qweechat.py
+----------------------------------------
 
 
-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
-$ python setup.py install
+----------------------------------------
+
+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 WeeeChat)
+* '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.