Fix typo in INSTALL

[irc/weechat/qweechat.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 0f5b1cc1c6f61096338301fb06151f875d980758..5c1d5a5727f961286317c9c9b7d7366beac978c5 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,50 +1,60 @@
-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
-$ python setup.py install
+----
+
+To install in your home:
 
+----
+$ python setup.py install --home=~/qweechat
+----
 
-WeeChat setup
--------------
+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
-------------------
+== 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)
+* '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.