add readme

This commit is contained in:
JOLIMAITRE Matthieu 2024-04-30 17:20:11 +02:00
parent 3ac586e7e1
commit 67cb11793b

30
README.md Normal file
View file

@ -0,0 +1,30 @@
# Turbo TUSMO
Programme pour résolution de Tusmo.
## Usage
### Dépendances
- deno
- windows `winget install deno`
- debian `sudo apt install deno`
- archlinux `sudo pacman -S deno`
### Simulation
```sh
./src/simulation.ts -h
# Usage: simulation
#
# Description:
#
# Program to simulate TUSMO game with guesser controller.
#
# Options:
#
# -h, --help - Show this help.
# -f, --file <path> - Sets dictionnary to use words from (defaults to internal french dict).
# -n, --length <length> - Length of the word to use from the dictionnary. (Default: 6)
# -w, --wait <wait> - Time to wait between guesses, in ms. (Default: 0)
```