poezio/README

92 lines
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
Forge Page: http://codingteam.net/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
2010-10-04 01:45:16 +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
2010-11-15 11:59:09 +00:00
IRC. Poezio's commands are designed to be (if possible) like IRC
2010-06-08 23:39:07 +00:00
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.
All other IM-related XEP (wherever possible) should be implemented through
plugins or directly in poezio's core.
2010-01-10 20:14:17 +00:00
=======================
Install
=======================
2010-10-04 01:45:16 +00:00
You need python 3.0 or higher, and the SleekXMPP python library.
2010-11-15 11:59:09 +00:00
SleekXMPP can be found at http://github.com/fritzy/SleekXMPP.
2010-07-20 10:14:33 +00:00
you can launch poezio with
2010-11-15 11:59:09 +00:00
./launch.sh
or you can install it with (as root or with sudo)
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:
http://codingteam.net/project/poezio/doc
2010-10-04 01:45:16 +00:00
If you still have questions, or you're lost, don't hesitate to come
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
=======================
2010-10-04 01:45:16 +00:00
Florent Le Coz (louiz') <louiz@louiz.org> (main developper)
2010-01-10 20:14:17 +00:00
=======================
Contact/support
=======================
Jabber ChatRoom: poezio@conference.codingteam.net
2010-01-31 14:41:21 +00:00
Forum: http://codingteam.net/project/poezio/forum
Report a bug: http://codingteam.net/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)
2010-11-15 11:59:09 +00:00
Poezio is released under the Gnu GPLv3 license.
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 =
Link Mauve - Code
2010-01-31 23:59:58 +00:00
Gaëtan Ribémont (http://www.bonbref.com) - Logo design
2010-02-15 00:13:23 +00:00
Ovart - Testing
2010-10-05 20:01:07 +00:00
mathieui - Testing, Makefile, Documentation and Donation
Gapan - Makefile
2010-10-04 01:45:16 +00:00
Koshie - Donation
2010-10-12 23:23:06 +00:00
FlashCode (weechat dev) - Useful advices on how to use ncurses efficiently
Pipo - Ronrons
2010-02-13 15:18:39 +00:00
= Project =
2010-02-15 00:13:23 +00:00
Gajim - send_vcard method and common.py