summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDylan <boss@tehbox.org>2026-11-09 16:02:43 +1300
committerDylan <boss@tehbox.org>2026-11-09 16:02:43 +1300
commit046969c820e89b74d55c2d07c47470237f11cc2a (patch)
treeaec0899118712947027fe01942638cdadfe6e175 /README.md
parent89c9fd286a44a193187ea2b175d32136752518cb (diff)
downloadtigers-and-sheep-046969c820e89b74d55c2d07c47470237f11cc2a.tar.gz
tigers-and-sheep-046969c820e89b74d55c2d07c47470237f11cc2a.zip
feat: Parse the command line with clap
Players are now chosen with --sheep/-S and --tiger/-T (human, claude or a weights file) and --time/-t, instead of by editing main.rs. Every training setting is a train option, and --help covers all commands. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index c2549fd..888b961 100644
--- a/README.md
+++ b/README.md
@@ -39,8 +39,15 @@ With plain Rust (no Nix), `cargo` from a recent stable toolchain works too.
- **Click a move in the history** to go back to just before it.
- **q**, **Esc** or **Ctrl+C** quits.
-Which players `cargo run` uses is set in `src/main.rs`: `LocalPlayer` (you, with the mouse) or
-`ClaudePlayer` (the minimax computer player) on either side.
+By default the computer plays itself. Pick the players with `--sheep` and `--tiger`: `human`
+(you, with the mouse), `claude` (the minimax computer player), or a weights file for a neural
+player. `--time` sets how many seconds a computer player may think per move (default 2).
+
+```bash
+cargo run --release -- --sheep human --tiger claude --time 5
+```
+
+`--help` lists every command and option.
## Computer players
@@ -64,6 +71,8 @@ and against `ClaudePlayer`. The score against `ClaudePlayer` is the best guide t
Each generation is saved as `gen-NNN.bin`, and the newest as `latest.bin`. Running `train` again
carries on from the newest generation in the folder. `--from` starts from any weights file instead.
+The other training settings (search depth, ε, λ, epochs and so on) are options too; see
+`train --help`.
Then play against it, as sheep (the default) or as tigers: