Mercurial > xib

annotate README @ 8:1463f4620fca

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added some help in README Signed-off-by: Charly COSTE <changaco@changaco.net>
author Charly COSTE <changaco@changaco.net>
date Sun, 16 Aug 2009 22:04:06 +0200
parents 7d1745ca1dc2
children 1a1f2a0d35c7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
1 This is the first release of xib so some things are not implemented yet, if you want/need an error-safe bot, don't use this one !
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
2
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
3 Here is the list of the important things that still need to be implemented:
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
4 - handle kicks
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
5 - handle multiple bridges without risk of resource conflict
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
6
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
7 and a list of features that should be implemented but are not critical for usual use case:
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
8 - split logs into multiple files
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
9 - handle password-protected rooms
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
10 - handle room deletion and muc server reboot
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
11
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
12 xib includes its own version of the old irclib.py <http://python-irclib.sourceforge.net/> because this library doesn't correctly handle the different character encodings, I'm sorry about it but I don't have time to contribute to the upstream version right now, I don't know if it still has developers anyway
1
7d1745ca1dc2 Add dependencies to README
Charly COSTE <changaco@changaco.net>
parents: 0
diff changeset
13
7d1745ca1dc2 Add dependencies to README
Charly COSTE <changaco@changaco.net>
parents: 0
diff changeset
14 xib depends on:
7d1745ca1dc2 Add dependencies to README
Charly COSTE <changaco@changaco.net>
parents: 0
diff changeset
15 - python 2.6
8
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
16 - xmppony 0.1
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
17
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
18
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
19 How to install and run xib bots:
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
20
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
21 If you are not installing xib from a package manager I suggest you put the files in /usr/local/share/xib
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
22 To start xib bots just execute start_bots_from_xml_config.py, this script will search the *current* directory for a file named "config.xml" which must have the same schema as "example_config.xml".
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
23
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
24 How to log xib bots output:
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
25
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
26 xib does not directly handle logging for now so you have to do it the old school way, for example:
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
27 mkdir /var/log/xib
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
28 touch /var/log/xib/1.log
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
29 cd /usr/local/share/xib && ./start_bots_from_xml_config.py 1>/var/log/xib/log 2>&1 &