summaryrefslogtreecommitdiff
path: root/README
blob: bec3779d858ddbb12a7b621c17ad44e6f79fb17d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
	                      _
	                     (_)
	 _ __   ___   ___ _____  ___
	| '_ \ / _ \ / _ \_  / |/ _ \
	| |_) | (_) |  __// /| | (_) |
	| .__/ \___/ \___/___|_|\___/
	| |
	|_|

Homepage:	http://poezio.eu
Forge Page:	http://codingteam.net/projet/poezio

Poezio is a console Jabber/XMPP client. Its goal is to use anonymous
connections to simply let the user join MultiUserChats. This way, the user
doesn't have to create a Jabber account, exactly like people are using
IRC. Poezio's commands are designed to be (if possible) like IRC
clients (weechat, irssi, etc).
Since version 0.7, poezio can handle real Jabber accounts along with
roster and one to one conversation, making it a full-featured console
Jabber client, but still MultiUserChats-centered.

=======================
	Install
=======================
You need python 3.0 or higher, and the SleekXMPP python library.
You can find my patched version at http://github.com/louiz/SleekXMPP until
my changes (required to properly run poezio) are merged upstream.

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 ;))
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
first launch)

Please, see the online documentation for more information on installing,
configuring or using poezio:
http://codingteam.net/project/poezio/doc

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).

Please DO report any bug you encounter and ask for any
feature you want.

=======================
	Authors
=======================
Florent Le Coz (louiz') <louiz@louiz.org> (main developper)

=======================
    Contact/support
=======================
Jabber ChatRoom:   poezio@conference.codingteam.net
Forum:             http://codingteam.net/project/poezio/forum
Report a bug:      http://codingteam.net/project/poezio/bugs/add

=======================
	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

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/)

=======================
	Thanks
=======================
= People =
 Link Mauve - Code (a little)
 Erwan Briand - Code
 Gaëtan Ribémont (http://www.bonbref.com) - Logo design
 Ovart - Testing
 mathieui - Testing, Makefile, Documentation and Donation
 Gapan - Makefile
 Koshie - Donation
= Project =
 Gajim - send_vcard method and common.py

=======================
        Donate
=======================
If you're willing to thank me, or ask for an on-demand feature, please
see the page http://louiz.org/donate.html and contact me.