mirror of
https://github.com/maaslalani/gambit.git
synced 2024-11-21 16:46:50 +02:00
doc: add assets
This commit is contained in:
parent
b981acf09f
commit
428556d751
28
README.md
28
README.md
@ -1,13 +1,9 @@
|
||||
<img src="./assets/gambit.png?raw=true" alt="Gambit: Play chess in your terminal" />
|
||||
|
||||
# Gambit
|
||||
|
||||
Chess board in your terminal.
|
||||
|
||||
<br/>
|
||||
<p align="center">
|
||||
<img width="90%" src="./chess.gif?raw=true" alt="Terminal chess" />
|
||||
</p>
|
||||
<br/>
|
||||
|
||||
### Installation
|
||||
|
||||
```sh
|
||||
@ -21,14 +17,6 @@ git clone github.com/maaslalani/gambit
|
||||
go run ./...
|
||||
```
|
||||
|
||||
|
||||
### Move
|
||||
|
||||
There are two ways to move in `gambit`:
|
||||
|
||||
* Type out the square the piece you want to move is on, then type out the square to which you want to move the piece.
|
||||
* With the mouse, click on the target piece and target square.
|
||||
|
||||
### Play
|
||||
|
||||
You can play a game by running:
|
||||
@ -40,6 +28,18 @@ gambit
|
||||
You can press <kbd>ctrl+f</kbd> to flip the board to give a better perspective
|
||||
for the second player.
|
||||
|
||||
<br/>
|
||||
<p align="center">
|
||||
<img width="90%" src="./assets/chess.gif?raw=true" alt="Terminal chess" />
|
||||
</p>
|
||||
|
||||
### Move
|
||||
|
||||
There are two ways to move in `gambit`:
|
||||
|
||||
* Type out the square the piece you want to move is on, then type out the square to which you want to move the piece.
|
||||
* With the mouse, click on the target piece and target square.
|
||||
|
||||
### Future
|
||||
|
||||
In the future, `gambit` will support:
|
||||
|
Before Width: | Height: | Size: 5.3 MiB After Width: | Height: | Size: 5.3 MiB |
BIN
assets/gambit.png
Normal file
BIN
assets/gambit.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 474 KiB |
Loading…
Reference in New Issue
Block a user