1
0
mirror of https://github.com/tiyn/yeschess.git synced 2025-04-03 15:37:46 +02:00

readme: added move notation documentation

This commit is contained in:
TiynGER 2021-05-08 01:15:49 +02:00
parent 53e1cc8df3
commit d5ac25a642

View File

@ -30,6 +30,11 @@ Documentation is written into the code via DocGen.
For this reason it is not saved in this repository. For this reason it is not saved in this repository.
To extract it into html run `nim doc --project --index:on --outdir:htmldocs game.nim` To extract it into html run `nim doc --project --index:on --outdir:htmldocs game.nim`
### Moves
Moves are read from the commandline as [pure coordinate notation](https://www.chessprogramming.org/Algebraic_Chess_Notation#Pure_coordinate_notation).
The inner program will convert this notation to a move-tuple.
### Board Representation ### Board Representation
Due to easier off the board checking a Due to easier off the board checking a