rg-chess 0.2.0

Chess Game with graphical interface.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

<h1 align="center">
    ✨ Chess ✨
</h1>

<div align="center">

<!-- see https://shields.io/ -->

![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)

</div>

## 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/chess.git
# or 
# ssh
git clone git@github.com:rust-games/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)

<!--
## How to Contribute

Thank you for considering and taking the time to contribute! Before contributing kindly read and follow [Code of Conduct](CODE_OF_CONDUCT.md). To help new developers/contributors there are set of instructions added in [CONTRIBUTING.md](CONTRIBUTING.md). Which describes the intial stages for working on this project. Also refer the [MIT License](LICENSE).
-->

## Potential Maintainers

📌 [Valentin Colin](https://github.com/ValentinColin)  
📌 [Marc Partensky](https://github.com/MarcPartensky)

## Credits

<a href="https://github.com/rust-games/chess/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=rust-games/chess" alt="contributors"/>
</a>