1
0
mirror of https://github.com/maaslalani/gambit.git synced 2024-12-30 21:19:52 +02:00

doc: readme update

This commit is contained in:
Maas Lalani 2021-11-27 01:20:17 -05:00
parent f3825aa99d
commit ecb957fd75
No known key found for this signature in database
GPG Key ID: F53774FA051C052A

View File

@ -5,16 +5,28 @@ Chess board in your terminal.
### Play
```
. . . . . . . . . .
. ♜ ♞ ♝ ♛ ♚ ♝ ♞ ♜ .
. ♟ ♟ ♟ ♟ ♟ ♟ ♟ ♟ .
. .
. .
. .
. .
. ♙ ♙ ♙ ♙ ♙ ♙ ♙ ♙ .
. ♖ ♘ ♗ ♕ ♔ ♗ ♘ ♖ .
. . . . . . . . . .
┌───┬───┬───┬───┬───┬───┬───┬───┐
8 │ ♜ │ ♞ │ ♝ │ ♛ │ ♚ │ ♞ │ ♝ │ ♜ │
├───┼───┼───┼───┼───┼───┼───┼───┤
7 │ ♟ │ ♟ │ ♟ │ ♟ │ ♟ │ ♟ │ ♟ │ ♟ │
├───┼───┼───┼───┼───┼───┼───┼───┤
6 │ │ │ │ │ │ │ │ │
├───┼───┼───┼───┼───┼───┼───┼───┤
5 │ │ │ │ │ │ │ │ │
├───┼───┼───┼───┼───┼───┼───┼───┤
4 │ │ │ │ │ │ │ │ │
├───┼───┼───┼───┼───┼───┼───┼───┤
3 │ │ │ │ │ │ │ │ │
├───┼───┼───┼───┼───┼───┼───┼───┤
2 │ ♙ │ ♙ │ ♙ │ ♙ │ ♙ │ ♙ │ ♙ │ ♙ │
├───┼───┼───┼───┼───┼───┼───┼───┤
1 │ ♖ │ ♘ │ ♗ │ ♕ │ ♔ │ ♘ │ ♗ │ ♖ │
└───┴───┴───┴───┴───┴───┴───┴───┘
A B C D E F G H
```
### Move
@ -30,7 +42,7 @@ _This will likely change in the future_.
`gambit` supports local and networked play. You can play a local game by
running `gambit` and moving the pieces. You can flip the board by pressing
<kbd>Space</kbd> to allow the second player to go.
<kbd>ctrl+f</kbd> to allow the second player to go.
For networked play, both players can run `gambit unique-room-id`, this will connect
For networked play (not available yet), both players can run `gambit unique-room-id`, this will connect
both players to a shared room in which both can take turns making moves.