Sfoglia il codice sorgente

darkirc/bots: update README and add requirements

dasman 1 anno fa
parent
commit
b239a284d1
1 ha cambiato i file con 38 aggiunte e 5 eliminazioni
  1. 38 5
      bin/darkirc/script/README.md

+ 38 - 5
bin/darkirc/script/README.md

@@ -21,14 +21,47 @@ is done through `meetbot_cfg.py`.
 `titlebot.py` is a bot used to print the title of a website provided by
 `titlebot.py` is a bot used to print the title of a website provided by
 a link in a `PRIVMSG`.
 a link in a `PRIVMSG`.
 
 
+### Requirements
+ `pip install beautifulsoup4 requests`
+
 ## `tweetifier`
 ## `tweetifier`
 `tweetifier` is yet another bot that recognizes Twitter links, fetch
 `tweetifier` is yet another bot that recognizes Twitter links, fetch
 the tweet text and print it out in irc.
 the tweet text and print it out in irc.
 
 
-## Requirment
+### Requirments
  `pip install tweety-ns`
  `pip install tweety-ns`
 
 
-## `tau-notifier`
-sends notifications about some `tau` commands (namely: adding a new 
-task, changing state, reassigning and new comments) to desired channels 
-in `darkirc`. 
+## `taubot`
+sends notifications about some `tau` commands (namely: adding or 
+stopping a task, changing state, reassigning and new comments) to 
+desired channels in `darkirc`. 
+
+### Requirements
+ `pip install argparse`
+
+## `mirror-bot`
+sends a copy of the message sent in an IRC server to another.
+
+### Requirements
+ `pip install argparse`
+
+## `commitbot`
+sends notifications about pushed code to `github` to desired channels 
+in `darkirc`. 
+
+### Requirements
+ - `pip install https.server`
+ - github webhook
+
+ ## `test-bot`
+sends a response to user sent 'test' or 'echo' `PrivMsg`s.
+
+## Setup
+
+* Create a new darkirc config for the bot.
+* Edit the config for your needs.
+* Run a `darkirc` instance, make sure to point it to the new config.
+* Run the bot script.
+
+**Notes:**
+* Make sure the `irc_listen` is the same in config and in bot script.