Read Me

= pjaiku: Python client for Jaiku.com =

Please visit http://h.ordia.com.ar/proj/pjaiku for the latest version.

Copyright (C) 2007 by Hernán Ordiales
<code@ordia.com.ar>


== License ==

This program 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 2 of the License, or
(at your option) any later version.

This program 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 this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

For more details about GPL please see LICENSE file


== Requirements ==

* Python intepreter.
* PyQt4.
* simplejson and xmlrpc python libs.

(for example in a debian based system something like: 'sudo apt-get install python-qt4 python-simplejson')

Since is written in Python, pjaiku is crossplatform. At the moment was only tested under GNU/Linux and Windows, but would be nice hear about tests in others platforms (contact here: http://h.ordia.com.ar/blog/contact.php)


== Use  ==

At linux systems install the package and its dependencies and run it from its desktop icon or execute 'pjaiku' from a console. At windows systems run the installer and execute pjaiku.exe. If you had downloaded the .tar.gz, decompress it and run 'pjaiku.py --local' with the python interpreter. First time the program will ask you for your jaiku username and your api key (you can check http://api.jaiku.com/key to obtain it).

At the moment only tested under GNU/Linux and Windows, but would be nice to hear about tests in others platforms.


== Shorcuts ==

 'ctrl+u': update jaikus
 'ctrl+k': sets on/off update kopete status
 'ctrl+o': sets on/off only contacts filter
 'ctrl+p': posts a jaiku
 'ctrl+q': quits