| 
									
										
										
										
											2014-03-06 09:48:29 +01:00
										 |  |  | = QWeeChat | 
					
						
							|  |  |  | :author: Sébastien Helleu | 
					
						
							|  |  |  | :email: flashcode@flashtux.org | 
					
						
							|  |  |  | :lang: en | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-01-16 13:19:08 +01:00
										 |  |  | image:https://travis-ci.org/weechat/qweechat.svg?branch=master["Build Status", link="https://travis-ci.org/weechat/qweechat"] | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2014-03-06 09:48:29 +01:00
										 |  |  | QWeeChat is a Qt remote GUI for WeeChat written in Python. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2014-11-24 20:19:01 +01:00
										 |  |  | Homepage: https://weechat.org/ | 
					
						
							| 
									
										
										
										
											2014-03-06 09:48:29 +01:00
										 |  |  | 
 | 
					
						
							|  |  |  | == Features | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | * Multi-platform (GNU/Linux, *BSD, Mac OS X, QNX, Windows & others). | 
					
						
							|  |  |  | * Free software, released under GPLv3. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-10-03 11:05:53 +02:00
										 |  |  | image::https://weechat.org/media/images/screenshots/relay/medium/qweechat_shadow.png[align="center"] | 
					
						
							| 
									
										
										
										
											2014-03-06 09:48:29 +01:00
										 |  |  | 
 | 
					
						
							|  |  |  | == 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) | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2014-05-08 17:40:31 +02:00
										 |  |  | === Install via source distribution | 
					
						
							| 
									
										
										
										
											2014-03-06 09:48:29 +01:00
										 |  |  | 
 | 
					
						
							|  |  |  | ---- | 
					
						
							| 
									
										
										
										
											2014-05-08 17:40:31 +02:00
										 |  |  | $ python setup.py install | 
					
						
							| 
									
										
										
										
											2014-03-06 09:48:29 +01:00
										 |  |  | ---- | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | == 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 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-01-15 07:40:40 +01:00
										 |  |  | Copyright (C) 2011-2016 Sébastien Helleu <flashcode@flashtux.org> | 
					
						
							| 
									
										
										
										
											2014-03-06 09:48:29 +01:00
										 |  |  | 
 | 
					
						
							|  |  |  | 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/>. |