diff --git a/README.md b/README.md new file mode 100644 index 0000000..beda5e7 --- /dev/null +++ b/README.md @@ -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 - Sets dictionnary to use words from (defaults to internal french dict). +# -n, --length - Length of the word to use from the dictionnary. (Default: 6) +# -w, --wait - Time to wait between guesses, in ms. (Default: 0) +```