Skip to content

Commit

Permalink
Clean up bots guide.
Browse files Browse the repository at this point in the history
Due to the directory symlink structure in the dev VM, including the
`~/zulip/contrib_bots/` prefix in the command for running a bot causes
`run.py` to fail with an error.
  • Loading branch information
robot-dreams authored and timabbott committed May 22, 2017
1 parent c8a203b commit 59bfc9b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/bots-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,15 +99,15 @@ You need:
* To subscribe your bot to streams, navigate to *Manage
Streams*. Select a stream and add your bot by its email address
(the address you assigned in step 3).
* Now, the bot do its job on the streams you subscribed it to.
* Now, the bot can do its job on the streams you subscribed it to.
* (In future versions of the API, this step may not be required).

4. Run the bot.

* In your Zulip repository, navigate to `~/zulip/contrib_bots/`
* Run
```
python run.py ~/zulip/contrib_bots/bots/<my-bot>/<my-bot>.py --config-file ~/.zuliprc`
python run.py bots/<my-bot>/<my-bot>.py --config-file ~/.zuliprc`
```
(using the path to the `.zuliprc` file from step 2).
* Check the output of the command. It should start with the text
Expand Down

0 comments on commit 59bfc9b

Please sign in to comment.