✨ Chess ✨
![Issues tag](https://img.shields.io/github/issues/rust-games/chess)
![Forks tag](https://img.shields.io/github/forks/rust-games/chess)
![Stars](https://img.shields.io/github/stars/rust-games/chess?style=social)
![Licence](https://img.shields.io/github/license/rust-games/chess)
## Project Description
A simple game of chess write in [Rust](https://www.rust-lang.org/fr/).
## Table of Contents
* [Installation](#installation)
* [System requirement](#system-requirement)
* [Software requirement](#software-requirement)
* [Manual installation](#manual-installation)
* [Tests](#tests)
* [Usage](#usage)
* [Chess Notation](#chess-notation)
* [Potential Maintainers](#potential-maintainers)
* [Credits](#credits)
## Installation
### System requirement
1. Any system with basic configuration.
2. Operating System : Any (Windows / Linux / Mac).
### Software requirement
1. Cargo/Rust installed (If not download it [here](https://doc.rust-lang.org/cargo/getting-started/installation.html)).
### Manual installation
```bash
# https
git clone https://github.com/rust-games/rg-chess.git
# or
# ssh
git clone git@github.com:rust-games/rg-chess.git
cargo build --release
```
> **Note**: if you don't build in `release`, the game may be slow.
## Tests
```bash
cargo test
```
## Usage
```bash
cargo run --release
```
## Chess book
### [MdBook](https://rust-games.github.io/chess/)
## Chess Notation
### [Forsyth-Edwards Notation (FEN)](https://www.chess.com/terms/fen-chess) -> implemented
### [Standard Algebraic Notation (SAN)](https://www.chess.com/article/view/chess-notation)
## Potential Maintainers
📌 [Valentin Colin](https://github.com/ValentinColin)
📌 [Marc Partensky](https://github.com/MarcPartensky)
## Credits