Permalink
Browse files

started cleanup of docs

  • Loading branch information...
1 parent 98d4b0d commit 59695b41d427d9ac7a18f5ab8c91351dbd99d014 @bmuller committed Aug 23, 2011
Showing with 11 additions and 14 deletions.
  1. +1 −6 LICENSE
  2. +10 −5 README.markdown
  3. +0 −3 TODO
View
@@ -1,9 +1,4 @@
-The files in the BermiInflector directory are released under the
-license described in the file BSD-LICENSE found in that folder.
-All other code is released with the following copyright and under
-the following license:
-
-Copyright (c) 2010 Butterfat, LLC
+Copyright (c) 2011 Brian Muller
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
View
@@ -6,22 +6,27 @@ Campfirer is a Jabber (XMPP) MUC component that provides a gateway to [Campfire]
## Prerequisites
1. First, edit your jabber server config file to allow for a new component connection. If you are using [ejabberd](http://www.ejabberd.im/), this can be done by adding the following lines to the services section of your *ejabberd.cfg* file. Make sure to change the password to something actually secret, and then restart your jabber server.
- {5524, ejabberd_service, [ {ip, {127, 0, 0, 1}}, {access, all}, {shaper_rule, fast}, {host, "campfirer.localhost", [{password, "secret"}]} ]},
+ {5524, ejabberd_service, [
+ {ip, {127, 0, 0, 1}},
+ {access, all},
+ {shaper_rule, fast},
+ {host, "campfirer.localhost", [{password, "secret"}]}
+ ]},
2. Install [Twisted](http://twistedmatrix.com).
-3. Install [Twistar](http://findingscience.com/twistar/)
+
## Installation
First, get the source:
+
git clone git://github.com/bmuller/campfirer.git
Then, within the campfirer directory:
+
sudo python setup.py install
-Then, after creating a database and setting up a user account that can access it, import the DB structure:
- mysql -u <user> -p <dbname> < db/mysql.sql
+Copy config.py.dist to config.py and edit it for your configuration. You can then copy your config.py and the campfirer.tac file anywhere you'd like and can start the server with:
-At this point, you can copy config.py.dist to config.py and edit it for your configuration. At this point, you can copy your config.py and the campfirer.tac file anywhere you'd like and can start the server with:
twistd -noy campfirer.tac
See the twistd man page for more information.
View
3 TODO
@@ -1,3 +0,0 @@
-messagelist now contains all last 100 messages. when muc.handleRoomUpdate is called, all 100 are reprocessed each time.
-
-There should be the concept of "last_added" or something like that

0 comments on commit 59695b4

Please sign in to comment.