Skip to content

Commit 84f507a

Browse files
Update README.md
I added the ReadMe to showcase what the project is all about.
1 parent b5e4197 commit 84f507a

File tree

1 file changed

+39
-2
lines changed

1 file changed

+39
-2
lines changed

README.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,39 @@
1-
# Machine-Learning-Chess
2-
[INSERT]
1+
# GUI Chess Game
2+
3+
This is a fully functional GUI implementation of the game Chess, in Python.
4+
5+
## Motivation
6+
7+
My motivation behind this project was to create a Machine Learning Agent that plays chess at a superhuman level. I will be using this engine to make that project a reality.
8+
9+
## Screenshots
10+
11+
#### The board in a starting position:
12+
<img src="https://user-images.githubusercontent.com/34556399/42402221-66416c8e-8147-11e8-809d-33c1f81cae7b.png" alt="starting" width="400px"/>
13+
14+
#### The board when choosing the piece to promote a pawn into:
15+
<img src="https://user-images.githubusercontent.com/34556399/42402213-5e379874-8147-11e8-8b5f-30f360145603.png" alt="promotion" width="400px"/>
16+
17+
## Prerequisites
18+
19+
* Kivy
20+
```
21+
$ sudo apt-get install python3-kivy
22+
```
23+
24+
## How to Run
25+
26+
Run:
27+
```
28+
python3 main.py
29+
```
30+
31+
## How to Use
32+
33+
* To move the pieces just click the desired piece and release in the desired square
34+
* To castle move the king in the correct location and the rook will move on it's own
35+
* To promote a pawn, once the popup of the four pieces appear click on the desired piece and everything will change for you!
36+
37+
## License
38+
39+
MIT © Dylan Snyder

0 commit comments

Comments
 (0)