README.rst 4.18 KB
Newer Older
louiz’'s avatar
louiz’ committed
1 2
poezio
======
3

4
Homepage:      https://poez.io
mathieui's avatar
mathieui committed
5

6
Forge Page:    https://lab.louiz.org/poezio/poezio
7

8
Poezio is a console Jabber/XMPP client.  Its goal is to use anonymous
louiz’'s avatar
louiz’ committed
9
connections to simply let the user join MultiUserChats.  This way, the user
10
doesn't have to create a Jabber account, exactly like people are using
louiz’'s avatar
louiz’ committed
11 12
IRC.  Poezio's commands are designed to be (if possible) like commonly
used IRC clients (weechat, irssi, etc).
mathieui's avatar
mathieui committed
13

14
Since version 0.7, poezio can handle real Jabber accounts along with
mathieui's avatar
mathieui committed
15
roster and one-to-one conversations, making it a full-featured console
16
Jabber client, but still MultiUserChats-centered.
mathieui's avatar
mathieui committed
17
In the future, poezio should implement at a 100% level all XEP related to
18
MUCs, especially XEP 0045.
19

louiz’'s avatar
louiz’ committed
20 21
Install
=======
mathieui's avatar
mathieui committed
22

23
You need python 3.5 or higher (preferably the latest) and the associated devel
mathieui's avatar
mathieui committed
24 25
package, to build C modules, and the slixmpp python library.
You also need aiodns if you want SRV record support.
mathieui's avatar
mathieui committed
26 27 28 29 30

Additionally, you’ll need sphinx to build the documentation pages.
To read the documentation without these dependancies just read the rst
files in the doc/source/ directory or the generated documentation on the
website.
31

32
The simplest way to have up-to-date dependencies and to be able to test
mathieui's avatar
mathieui committed
33
this developement version is to use the ``update.sh`` script that downloads
34
them, places them in the right directory, and builds the C module.
35

36
You can then launch poezio with
37

mathieui's avatar
mathieui committed
38
::
louiz’'s avatar
louiz’ committed
39

mathieui's avatar
mathieui committed
40
    $ ./launch.sh
louiz’'s avatar
louiz’ committed
41

mathieui's avatar
mathieui committed
42
you can now simply launch ``poezio``
43

mathieui's avatar
mathieui committed
44
You can edit the configuration file which is located in
mathieui's avatar
mathieui committed
45 46 47
``~/.config/poezio/poezio.cfg`` by default, and you will have to copy
and edit ``data/default_config.cfg`` if you want to edit the config before
the first launch. The default config file is fully commented, but you can
mathieui's avatar
mathieui committed
48 49
also read the “Configuration” documentation page which has links between
options and longer descriptions.
50

mathieui's avatar
mathieui committed
51
Please see the online documentation for more information on installing,
52
configuring or using poezio: https://doc.poez.io/
53

louiz’'s avatar
louiz’ committed
54
If you still have questions, or if you're lost, don't hesitate to come
55 56
talk to us directly on our Jabber chat room (see Contact section).

mathieui's avatar
mathieui committed
57 58
Please DO report any bug you encounter and ask for any feature you want
(we may implement it or not, but it’s always better to ask).
59

louiz’'s avatar
louiz’ committed
60 61
Authors
=======
62

mathieui's avatar
mathieui committed
63 64
- Florent Le Coz (louiz’) <louiz@louiz.org> (developer)
- Mathieu Pasquet (mathieui) <mathieui@mathieui.net> (developer)
Link Mauve's avatar
Link Mauve committed
65
- Emmanuel Gil Peyrot (Link Mauve) <linkmauve@linkmauve.fr> (developer)
66

louiz’'s avatar
louiz’ committed
67 68
Contact/support
===============
mathieui's avatar
mathieui committed
69 70 71

Jabber ChatRoom:   `poezio@muc.poez.io <xmpp:poezio@muc.poez.io?join>`_

72
Report a bug:      https://lab.louiz.org/poezio/poezio/issues/new
73

louiz’'s avatar
louiz’ committed
74 75
License
=======
mathieui's avatar
mathieui committed
76

77 78 79
Poezio is Free Software.
(learn more: http://www.gnu.org/philosophy/free-sw.html)

80
Poezio is released under the zlib License.
81
Please read the COPYING file for details.
82

83
The artwork logo was made by Gaëtan Ribémont and released under
84 85
the Creative Commons BY license (http://creativecommons.org/licenses/by/2.0/)

86

louiz’'s avatar
louiz’ committed
87 88
Hacking
=======
mathieui's avatar
mathieui committed
89

mathieui's avatar
mathieui committed
90 91 92 93 94
If you want to contribute, you will be welcome on
`poezio@muc.poez.io <xmpp:poezio@muc.poez.io?join>`_ to announce your
ideas, what you are going to do, or to seek help if you have trouble
understanding some of the code.

louiz’'s avatar
louiz’ committed
95 96 97 98 99 100 101 102
The preferred way to submit changes is through a merge request on gitlab,
at https://lab.louiz.org/poezio/poezio, but we also accept contributions
on github, or with a simple “please fetch my code on my personal git
repository hosted somewhere”


Thanks
======
mathieui's avatar
mathieui committed
103

mathieui's avatar
mathieui committed
104 105 106
- People:
    - Todd Eisenberger - Plugin system and OTR support
    - Jérôme Parment (Manfraid) - Code, testing
107 108 109 110 111 112 113 114 115
    - Akim Sadaoui - Code
    - Florian Duraffourg - Code
    - Frédéric Meynadier - Code
    - Georg Lukas - Code
    - Johannes Krude - Code
    - Łabędź - Code
    - Lasse Aagren - Code
    - Lancelot SIX - Code
    - Luke Marlin - Code
Maxime Buquet's avatar
Maxime Buquet committed
116
    - Maxime Buquet - Code
117
    - Nicolas Braud-Santoni - Code
mathieui's avatar
mathieui committed
118 119
    - Perdu - Code
    - Eijebong - Code
120
    - Gaëtan Ribémont - Logo design
mathieui's avatar
mathieui committed
121 122 123 124 125 126
    - Ovart - Testing
    - Koshie - Donation
    - Gapan - Makefile
    - FlashCode (weechat dev) - Useful advices on how to use ncurses efficiently
    - And all the people using and testing poezio, and especially the ones present
      on the jabber chatroom doing bug reports and/or feature requests.