From ce8979df7ac31cef926a3cef26e06d19b552c55b Mon Sep 17 00:00:00 2001 From: Jerry Zhang Date: Tue, 12 Dec 2017 16:59:20 -0800 Subject: [PATCH] interactive bots: Improve documentation for tictactoe bot. --- zulip_bots/zulip_bots/bots/tictactoe/doc.md | 25 ++++++++++++--------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/zulip_bots/zulip_bots/bots/tictactoe/doc.md b/zulip_bots/zulip_bots/bots/tictactoe/doc.md index 3697a7a..7ff617e 100644 --- a/zulip_bots/zulip_bots/bots/tictactoe/doc.md +++ b/zulip_bots/zulip_bots/bots/tictactoe/doc.md @@ -1,4 +1,4 @@ -# About Tic-Tac-Toe Bot +# Tic-Tac-Toe Bot This bot allows you to play tic-tac-toe in a private message with the bot. Multiple games can simultaneously be played by different users, each playing @@ -6,18 +6,21 @@ against the computer. The bot only responds to messages starting with @mention of the bot(botname). -### Commands -**@mention-botname new** will start a new game (but not if you are -already playing a game.) You must type this first to start playing! +## Setup +This bot does not require any special setup. Just run it according to the +instructions in [this guide](https://zulipchat.com/api/running-bots#running-a-bot). -**@mention-botname help** will return a help function with valid -commands and coordinates. +## Commands +* `@mention-botname new` - start a new game (but not if you are already +playing a game.) You must type this first to start playing! -**@mention-botname quit** will quit from the current game. +* `@mention-botname help` - return a help message. -**@mention-botname ** will make a move at the -entered coordinate. For example, **@mention-botname 1,1** . After this, the bot will make -its move, or declare the game over if the user or bot has won. +* `@mention-botname quit` - quit the current game. + +* `@mention-botname ` - make a move at the entered coordinate. +For example, `@mention-botname 1,1` . After this, the bot will make its +move, or declare the game over if the user or bot has won. Coordinates are entered in a (row, column) format. Numbering is from top to bottom and left to right. @@ -31,4 +34,4 @@ and spaces are optional. (3, 1) | (3, 2) | (3, 3) Invalid commands will result in an "I don't understand" response from the bot, -with a suggestion to type **@mention-botname help** . +with a suggestion to type `@mention-botname help`.