From b58aafc61f626dbd47a4b81914a6ddb1d9e4207c Mon Sep 17 00:00:00 2001 From: Joseph Montanaro Date: Wed, 14 Jul 2021 21:48:48 -0700 Subject: [PATCH] add readme and rename main file --- README.md | 21 +++++++++++++++++++++ main.nim => cup.nim | 0 2 files changed, 21 insertions(+) create mode 100644 README.md rename main.nim => cup.nim (100%) diff --git a/README.md b/README.md new file mode 100644 index 0000000..bda5dc8 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# `cup` - CamelUp probability calculator + +This tool calculates probable outcomes for the board game CamelUp. +It can calculate all possible outcomes for a single game leg in about 5ms, so effectively instantaneously. +Full-game calculations take a little bit longer and are not exact (since it isn't practical to simulate all possible full game states.) +However it can easily simulate a million random games in about 80ms in the worst case, which should provide estimates accurate to within about 0.2%. + +``` +Usage: + cup [-i] SPACE:STACK [...SPACE:STACK] [DICE] + +SPACE refers to a numbered board space (1-16). +STACK refers to a stack of camel colors from bottom to top, e.g. + YBR (Yellow, Blue, Red, with Red on top). +DICE refers to the set of dice that have already been rolled, + e.g. GPR (Green, Purple, Red) + +Options: + -i Interactive mode (currently unimplemented) + -h Show this message and exit +``` \ No newline at end of file diff --git a/main.nim b/cup.nim similarity index 100% rename from main.nim rename to cup.nim