Permalink
Browse files

Add "Test Local Changes" section

Closes #36
  • Loading branch information...
1 parent 588906d commit 30b87dff8d6b115602d6d6cd1f74d2a4250bb0f8 Fernando Ortiz committed Jul 20, 2012
Showing with 17 additions and 4 deletions.
  1. +17 −4 README.md
View
21 README.md
@@ -19,18 +19,31 @@ You will need to set some environment variables to use this adapter.
### Heroku
% heroku config:add HUBOT_IRC_NICK="hubot"
-
% heroku config:add HUBOT_IRC_ROOMS="#hubot,#hubot-irc"
-
% heroku config:add HUBOT_IRC_SERVER="irc.freenode.net"
### Non-Heroku environment variables
% export HUBOT_IRC_NICK="hubot"
-
% export HUBOT_IRC_ROOMS="#hubot,#hubot-irc"
-
% export HUBOT_IRC_SERVER="irc.freenode.net"
+
+### Testing Local Changes
+
+ gem install foreman
+ git clone https://github.com/github/hubot.git
+ cd hubot
+ # this next line makes a deployable version of the bot for heroku or local deployments
+ make package
+ mv hubot/ ../testbot
+ cd ../testbot
+ - modify package.json to include the version of hubot-irc to test with either an official release or from your local repo
+ for an example see this https://gist.github.com/3148311
+ - modify Procfile, change adapter (-a option) to "irc" and change the name (-n option) of the bot
+ - make sure you followed the usage section from above to set the environment variables (Non-Heroku section)
+ foreman start
+
+ ...and that is it
## Contribute

0 comments on commit 30b87df

Please sign in to comment.