summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorThierry Carrez <thierry@openstack.org>2017-04-20 18:23:42 +0200
committerThierry Carrez <thierry@openstack.org>2017-04-20 18:23:42 +0200
commit42339394d526e8ac1a3706e5a08ca2168b4e3ea9 (patch)
treeb6972a50fb291be096cc82babfd85806db822a74 /README.rst
parent91350ee2083ad67afeeac13f4aa7bda12567a273 (diff)
Add testing instructions
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 5e914c3..3be902e 100644
--- a/README.rst
+++ b/README.rst
@@ -5,3 +5,43 @@ OpenStack PTG Bot
5ptgbot is the bot that PTG room moderators use to surface what's 5ptgbot is the bot that PTG room moderators use to surface what's
6currently happening at the event. It builds a static webpage that 6currently happening at the event. It builds a static webpage that
7attendees can query for up-to-date information. 7attendees can query for up-to-date information.
8
9Commands follow the following format:
10
11@ROOMNAME [until|at] TIME TOPIC
12
13
14Testing
15=======
16
17Copy config.ini.sample to config.ini:
18
19 cp config.ini.sample config.ini
20
21Edit config.ini contents, for example:
22
23[ircbot]
24nick=ptgbot
25pass=
26server=irc.freenode.net
27port=6667
28channels=testptg
29db=html/ptg.json
30
31In one terminal, run the bot:
32
33 tox -evenv -- ptgbot -d config.ini
34
35Join that channel and give a command to the bot:
36
37 @swift until 10:00 Discussing ring internals
38
39(note, the bot currently only takes commands from Freenode identified users)
40
41In another terminal, start the webserver:
42
43 cd html && python -m SimpleHTTPServer
44
45Open the web page in a web browser:
46
47 http://127.0.0.1:8000/ptg.html