mirror of
https://github.com/SleepingInsomniac/lx_chess_cr
synced 2025-02-07 20:46:08 +01:00
38 lines
836 B
Markdown
38 lines
836 B
Markdown
# lx_chess
|
|
|
|
A chess program written in crystal
|
|
|
|
## Installation
|
|
|
|
`shards build --release --no-debug`
|
|
|
|
## Usage
|
|
|
|
run `lx_chess --help` for usage information
|
|
|
|
Usage example:
|
|
|
|
```sh
|
|
╰─$ ./bin/lx_chess --fen "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1"
|
|
8: ♜ ♞ ♝ ♛ ♚ ♝ ♞ ♜
|
|
7: ♟ ♟ ♟ ♟ ♟ ♟ ♟ ♟
|
|
6:
|
|
5:
|
|
4:
|
|
3:
|
|
2: ♟ ♟ ♟ ♟ ♟ ♟ ♟ ♟
|
|
1: ♜ ♞ ♝ ♛ ♚ ♝ ♞ ♜
|
|
a b c d e f g h
|
|
```
|
|
|
|
## Contributing
|
|
|
|
1. Fork it (<https://github.com/your-github-user/cr_lx_chess/fork>)
|
|
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
3. Commit your changes (`git commit -am 'Add some feature'`)
|
|
4. Push to the branch (`git push origin my-new-feature`)
|
|
5. Create a new Pull Request
|
|
|
|
## Contributors
|
|
|
|
- [Alex Clink](https://github.com/sleepinginsomniac) - creator and maintainer
|