1
0
mirror of https://github.com/tiyn/yeschess.git synced 2025-10-15 12:31:16 +02:00

readme/license: updated/added

This commit is contained in:
TiynGER
2020-12-14 18:00:05 +01:00
parent 97406d4da3
commit 67a3ab4579
2 changed files with 688 additions and 2 deletions

View File

@@ -1,5 +1,16 @@
# ychess
**Attention**: This code is under construction and not finished yet.
ychess is a chess implementation written in nim.
A chess engine is planned.
## Usage
Simply download the code and run `nim c -r game.nim`.
You can now play a 1v1 hotseat game of chess in the commandline.
## Testing
Testing is done by `einheit` by [jyapayne](https://github.com/jyapayne/einheit).
All legal chess moves are implemented in `chess.nim` and tested by the TestSuite
in `test.nim`.
You can simply run the tests with `nim c -r test.nim`.