poezio/README

137 lines
4.5 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
Poezio is a console Jabber client. Its goal is to use anonymous
connections to 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-01-10 20:14:17 +00:00
IRC. It doesn't handle contact list at all.
2010-06-08 23:39:07 +00:00
Poezio's commands are designed to be (if possible) like IRC
clients (weechat, irssi, etc).
2010-01-10 20:14:17 +00:00
=======================
Install
=======================
2010-07-20 10:14:33 +00:00
You need python (with argparse, optionnaly)
and the xmpppy lib at the 0.5.0 version or higher.
2010-07-20 10:14:33 +00:00
you can launch poezio with
sh launch.sh
or you can install it with (as root or with sudo)
make install
(`make uninstall` works, don't worry ;))
2010-07-20 10:14:33 +00:00
you can then 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
first launch)
See the online documentation for more information:
http://codingteam.net/project/poezio/doc
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
=======================
Florent Le Coz (louiz') <louizatakk@fedoraproject.org> (main developper)
=======================
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)
Poezio is released under the Gnu GPLv3 license
Please read the COPYING file for details
2010-02-02 03:42:55 +00:00
The artwork logo is made by Gaëtan Ribémont and released under
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-02-01 20:31:47 +00:00
Erwan Briand - Handler and MultiUserChat classes
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-06-08 23:39:07 +00:00
mathieui - Testing
2010-02-13 15:18:39 +00:00
= Project =
2010-02-15 00:13:23 +00:00
Gajim - send_vcard method and common.py
2010-01-18 02:49:33 +00:00
======================
The code
======================
Classes:
- Connection *receives* messages from the Jabber network
- MultiUserChat *sends* messages to the Jabber network
- Gui displays everything on the screen and gets the user inputs
- Handler is the "link" between all these classes :
a class emits a signal and the others classes listen to this signal
and do what they have to do whenever this signal is emitted by any class
Q: Why not use Connection to receive AND send the messages to Jabber network?
A: I like it this way.
Q: Could you please make a nice ASCII art, so I could understand all
the beauty and the complexity of this awesome software ?
A: Of course, here it is:
2010-01-31 14:41:21 +00:00
___________________________
2010-01-18 02:49:33 +00:00
/ \
2010-01-31 14:41:21 +00:00
| |
| Jabber Network |
| (roomchats and people |
2010-06-08 23:39:07 +00:00
| inside them) |
| |
2010-01-31 14:41:21 +00:00
\__________________________/
| ^
| receive send | ____ Poezio ____
v |
/----------------\ /-----------------\
2010-06-08 23:39:07 +00:00
| | | |
2010-01-31 14:41:21 +00:00
| Connection | | MultiUserChat |
| | | |
2010-06-08 23:39:07 +00:00
\----------------/ \-----------------/
2010-01-31 14:41:21 +00:00
^ |emit emit | ^
| | /---------\ | |
connect \ \----> | |<----/ / connect
2010-06-08 23:39:07 +00:00
\______ | Handler |______/
2010-01-31 14:41:21 +00:00
| |
\---------/
| ^
connect | | emit
v |
2010-06-08 23:39:07 +00:00
/----------\ /---------\
| | | |
| Window |<--| Gui |
| etc | | |
\----------/ \---------/
| ^
| | Keyboard
| |
\ /---------\
\Screen | |
\ | YOU |
------->| |
2010-01-31 14:41:21 +00:00
\---------/