poezio/README

101 lines
3.3 KiB
Text
Raw Normal View History

2010-07-08 21:31:02 +00:00
_
(_)
_ __ ___ ___ _____ ___
| '_ \ / _ \ / _ \_ / |/ _ \
| |_) | (_) | __// /| | (_) |
| .__/ \___/ \___/___|_|\___/
| |
|_|
2010-06-08 23:39:07 +00:00
Homepage: http://poezio.eu
2011-01-10 00:17:48 +00:00
Forge Page: http://dev.louiz.org/projet/poezio
2010-01-10 20:14:17 +00:00
2010-11-15 11:59:09 +00:00
Poezio is a console Jabber/XMPP client. Its goal is to use anonymous
2011-01-12 20:36:27 +00:00
connections to simply let the user join MultiUserChats. This way, the user
2010-06-08 23:39:07 +00:00
doesn't have to create a Jabber account, exactly like people are using
2011-01-12 20:36:27 +00:00
IRC. Poezio's commands are designed to be (if possible) like commonly
used IRC clients (weechat, irssi, etc).
2010-10-04 01:45:16 +00:00
Since version 0.7, poezio can handle real Jabber accounts along with
2010-11-15 11:59:09 +00:00
roster and one to one conversations, making it a full-featured console
2010-10-04 01:45:16 +00:00
Jabber client, but still MultiUserChats-centered.
2010-11-15 11:59:09 +00:00
In the futur, poezio should implement at a 100% level all XEP related to
MUCs, especially XEP 0045.
2010-01-10 20:14:17 +00:00
=======================
Install
=======================
2011-09-11 18:16:46 +00:00
You need python 3.0 (and the associated devel package, to build C modules)
or higher, and the SleekXMPP python library.
In the developpement version, youll need this fork of SleekXMPP
http://github.com/louiz/SleekXMPP.
The simplest way to have up-to-date dependencies and to be able to test
this developpement version is to use the update.sh script that downloads
and places them in the right directory.
2011-09-11 18:16:46 +00:00
You also need to compile some external C modules, to do this, just enter
$ make
you can then launch poezio with
2011-09-11 18:16:46 +00:00
$ ./launch.sh
or you can install it with (as root or with sudo)
2011-09-11 18:16:46 +00:00
$ make install
2010-10-04 01:45:16 +00:00
(`make uninstall' works, don't worry ;))
you can now simply launch `poezio'
You can edit the config file (~/.config/poezio/poezio.cfg by default)
or data/default_config.cfg (if you want to edit the config before the
2010-11-15 11:59:09 +00:00
first launch). The default config file is fully commented.
2010-10-04 01:45:16 +00:00
Please, see the online documentation for more information on installing,
configuring or using poezio:
2011-01-10 00:17:48 +00:00
http://dev.louiz.org/project/poezio/doc
2011-01-12 20:36:27 +00:00
If you still have questions, or if you're lost, don't hesitate to come
2010-10-04 01:45:16 +00:00
talk to us directly on our Jabber chat room (see Contact section).
2010-06-08 23:39:07 +00:00
Please DO report any bug you encounter and ask for any
feature you want.
2010-01-10 20:14:17 +00:00
=======================
Authors
=======================
2011-01-12 20:36:27 +00:00
Florent Le Coz (louiz) <louiz@louiz.org> (main developper)
2011-05-11 19:23:22 +00:00
Mathieu Pasquet (mathieui) <mathieui@mathieui.net> (developper)
2010-01-10 20:14:17 +00:00
=======================
Contact/support
=======================
2011-01-10 00:17:48 +00:00
Jabber ChatRoom: poezio@kikoo.louiz.org
Forum: http://dev.louiz.org/project/poezio/forum
Report a bug: http://dev.louiz.org/project/poezio/bugs/add
2010-01-10 20:14:17 +00:00
=======================
License
=======================
Poezio is Free Software.
(learn more: http://www.gnu.org/philosophy/free-sw.html)
2011-09-11 15:10:05 +00:00
Poezio is released under the zlib License.
2010-11-15 11:59:09 +00:00
Please read the COPYING file for details.
2010-01-10 20:14:17 +00:00
2010-11-15 11:59:09 +00:00
The artwork logo was made by Gaëtan Ribémont and released under
2010-02-02 03:42:55 +00:00
the Creative Commons BY license (http://creativecommons.org/licenses/by/2.0/)
2010-01-10 20:14:17 +00:00
=======================
Thanks
=======================
= People =
2011-09-24 20:35:57 +00:00
Todd Eisenberger (todd@teisen.be) - Plugin system
2011-05-04 20:14:53 +00:00
Link Mauve - Code, testing
2010-01-31 23:59:58 +00:00
Gaëtan Ribémont (http://www.bonbref.com) - Logo design
2011-01-12 20:36:27 +00:00
Ovart - Testing
2010-10-04 01:45:16 +00:00
Koshie - Donation
2011-01-12 20:36:27 +00:00
Gapan - Makefile
2010-10-12 23:23:06 +00:00
FlashCode (weechat dev) - Useful advices on how to use ncurses efficiently
2010-02-13 15:18:39 +00:00
= Project =
2010-02-15 00:13:23 +00:00
Gajim - send_vcard method and common.py