Join & Part abilities now require you to be an admin
[infinity.git] / README
blob6eaa4e61b2d24aa3a0fef6b7effa16990f1f02f0
1   ######     ######   ####     ######     ######     ######        #
2     #                     ##     #                     #        #######
3 ########## ########## ###    ########## ########## ##########    # #
4     #      #        #    ###     #      #        #     #         # #
5     #             ##             #             ##      #      ##########
6     #           ##    ###        #           ##        #           #
7      ####     ##         ###      ####     ##           ####       #
8       infinity             an irc bot in haskell, v0.4
10 ,=====================================
11 1. overview
12 `=====================================
13 infinity is an IRC bot inspired by #haskell's lambdabot.
14 it is an extensible, dynamically code-swapping irc bot inspired
15 by the paper 'dynamic applications from the ground up.' this means
16 that as infinity is running, it is simple to update the code sitting
17 in a directory, and reload all of the code and compile it back into
18 the bot itself. 
20 along with this, it is extensible though an easy to use plugins 
21 interface, and state for plugins is supported through highly-efficient 
22 binary serialization using bytestrings.
25 ,=====================================
26 2. installation
27 `=====================================
28 please see INSTALL. there are several prerequisites to building infinity,
29 all of which are addressed there.
32 ,=====================================
33 3. contact, bugs, latest code, etc.
34 `=====================================
35 for the latest version of infinity directly from the code repository,
36 you may run:
38 git clone git://repo.or.cz/infinity.git
40 after this, simply running git pull will update the repository after further
41 patches have been applied.
43 if you have any bugs to report, patches to send (via git-format-patch,)
44 or you wish to contact me, you may do so at the following email address:
46 mad dot one at gmail dot com
48 aside from bugs/patches, i would love to see any plugins you've written
49 for infinity and they can be sent the same way or simply with a regular
50 email message.
51 if possible, usage of my gpg key would be appreciated:
53 http://thoughtpolice.stringsandints.com/austin.pubkey.gpg
55 preferably after adding my key to your keyring, a message should 
56 be sent and encrypted with gpg utilizing the  --armor flag so 
57 output is ASCII (i don't really care if the message itself
58 is the encryped ASCII or it's in an attachment.)
59 if you have a gpg key you would like me to reply with, send 
60 me a link to it and i'll reply using it. this isn't exactly
61 necessary, but it enhances my chances of replying sooner as
62 i get plenty of dumb email.
65 hope you have fun and happy hacking in the new year,
66 austin seipp, january 2008