-
-
Notifications
You must be signed in to change notification settings - Fork 378
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added Doc.md for game_of_fifteen bot #513
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@anehls93: Thanks for working on this! I just left a couple of comments I'd like you to address. Also, I would recommend squashing the two commits into one and then amending the commit message to be zulip_bots/game_of_fifteen: Add documentation.
Cheers!
@@ -0,0 +1,16 @@ | |||
# game_of_fifteen bot |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Replace this with Game of Fifteen Bot
:)
|
||
Game of Fifteen bot is a bot designed to let you play a game of fifteen. To summon it, simply type `@game_of_fifteen`, | ||
like so: | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make this:
This bot is designed to let you play a [game of fifteen](https://en.wikipedia.org/wiki/15_puzzle).
To start a new game, simply type:
@game_of_fifteen | ||
``` | ||
|
||
Run this bot as described in [here](https://zulipchat.com/api/running-bots#running-a-bot). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Replace as described in
with just as described
. :)
## Usage | ||
|
||
The goal of the game is to arrange all numbers from smallest to largest, starting with the grey question mark in the upper left corner, and then moving through each row until we hit the end. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Move this paragraph to the top of the previous section. Also, replace we hit the end
with till one reaches the end
.
We might want to amend this PR and merge it as the owner of it is no longer active. |
No description provided.