poezio/README

98 lines
3.3 KiB
Text
Raw Normal View History

2010-01-10 20:14:17 +00:00
=======================
= Poezio =
=======================
Homepage: http://codingteam.net/projet/poezio
Poezio is a console Jabber client. Its goal is to use anonymous
connections to let the user join MultiUserChats. This way, the user
don't have to create a Jabber account, exactly like people are using
IRC. It doesn't handle contact list at all.
2010-01-31 05:33:54 +00:00
Poezio's commands are design to be (if possible) like well known IRC
clients (weechat, irssi, mirc).
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
=======================
Thanks
=======================
= People =
xbright (Handler and MultiUserChat classes)
chickenzilla (Config class)
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 |
| in them) |
| |
\__________________________/
| ^
| receive send | ____ Poezio ____
v |
/----------------\ /-----------------\
| | | |
| Connection | | MultiUserChat |
| | | |
2010-01-18 02:49:33 +00:00
\----------------/ \-----------------/
2010-01-31 14:41:21 +00:00
^ |emit emit | ^
| | /---------\ | |
connect \ \----> | |<----/ / connect
2010-01-18 02:49:33 +00:00
\______ | Handler |______/
2010-01-31 14:41:21 +00:00
| |
\---------/
| ^
connect | | emit
v |
2010-01-18 02:49:33 +00:00
/---------\
2010-01-31 14:41:21 +00:00
| |
2010-01-18 02:49:33 +00:00
| Gui |
2010-01-31 14:41:21 +00:00
| |
\---------/
| ^
Screen | | Keyboard
v |
2010-01-18 02:49:33 +00:00
/---------\
2010-01-31 14:41:21 +00:00
| |
| YOU |
| |
\---------/