Skip to content

Fix example in README #7

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.

Sign up for GitHub

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

Merged
Stannislav merged 2 commits into from
Feb 22, 2025
Merged

Fix example in README #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fac6bb1
Update usage example in README
Stannislav Feb 22, 2025
63df9dc
Bump patch version
Stannislav Feb 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 22 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,32 @@ The generated positions are random, which is different to Lichess' presets.

```text
$ chessg
Generate chess positions and practise on Lichess.
╭─ Positions ─╮ ╭──────────── Commands ────────────╮
│ 1 Q │ │ h Help │
│ 2 R │ │ enter Use previous choice │
│ 3 B+B │ │ q, Ctrl+D Quit │
│ 4 B+N │ ╰──────────────────────────────────╯
│ 5 Custom │
╰─────────────╯
Position: 4
. . K . . . . .
. . . B . . . .
╭────────────────────────── Piece Input ──────────────────────────╮ ╭────────── Commands ──────────╮
│ Generate chess positions and practise on Lichess. │ │ h Help │
│ │ │ Enter Use previous input │
│ Provide the symbols of the pieces to place on the board. White │ │ Ctrl+D Quit │
│ pieces are P, N, B, R, Q, black pieces are p, n, b, r, q. Kings │ ╰──────────────────────────────╯
│ are automatically added and must not be part of the input. │
│ You can separate piece symbols by commas and/or spaces. │
│ │
│ Examples: │
│ │
│ Qr - queen against rook │
│ R, p, p - rook against two pawns │
│ N B B q - knight and two bishops against a queen │
│ │
╰─────────────────────────────────────────────────────────────────╯
Position: BN
. . . k . . . .
. . . . . . . .
. . . . . . . .
. N . . . . . .
. . . . . . . .
. . . . k . . .
. . . . . . . N
B . . . . . . .
. . . . K . . .
. . . . . . . .
https://lichess.org/?fen=2K5/3B4/8/8/8/4k3/7N/8%20w%20-%20-%200%201#ai
Choice: ^D
https://lichess.org/?fen=3k4/8/8/1N6/8/B7/4K3/8%20w%20-%20-%200%201#ai
Position (enter = BN): ^D
Bye!
```

Expand Down
2 changes: 1 addition & 1 deletion chess_gen.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
from rich.panel import Panel
from rich.table import Table

__version__ = "1.2.0"
__version__ = "1.2.1"

WHITE_PAWN = Piece.from_symbol("P")
BLACK_PAWN = Piece.from_symbol("p")
Expand Down
Loading