Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Tickloop committed May 17, 2022
1 parent 17a4fb6 commit ec8d902
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ This game is a simple guessing game where you have to guess a 5 letter word.

We have 12478 different words for you to play this game with!

Keep trying your luck as you have 5 chances to find the correct one.
Keep trying your luck as you have 6 chances to find the correct one.

## Rules of the game
---

1. You get 5 tries for correctly guessing the word

1. You get 6 tries for correctly guessing the word
2. Each guess comes back with a feedback:
* If a character is highlighted with green means it is correct
* If a character is highlighted with red means it is incorrect
Expand All @@ -18,7 +18,7 @@ Keep trying your luck as you have 5 chances to find the correct one.


## Environment Setup
---


You will require python3.6.9 or above and the dependencies in requirements.txt to run the game.

Expand All @@ -34,5 +34,8 @@ or:

python3 game.py

## Neural Network


<img style="display: block; margin-left: auto; margin-right: auto; width: 30%;" src="word-game.png" alt="Example run">
This repository also hosts a neural network that is trained to play the game.
If you wish to test you skills against the neural network, you can clone this repository and train it yourself by running main.py

0 comments on commit ec8d902

Please sign in to comment.