summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrandon C. Irizarry <brandon.irizarry@gmail.com>2026-04-23 17:32:16 -0400
committerBrandon C. Irizarry <brandon.irizarry@gmail.com>2026-04-23 17:32:16 -0400
commite3cd958093eafa40c8274bee4c61424f0ae39c44 (patch)
tree63bca133e58d6fa90d9894c38c0c86985ad80a85
parent0b945b58ef7ba7d153c25fb86e9b4c5a09003ef0 (diff)
docs: expand README
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
index 99c2491..1497214 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,26 @@
+# A Party of Dice
+
+A game simulation I wrote to help me better understand Go concurrency
+concepts.
+
+Based loosely on the `makeThumbnails6` example in Chapter 8 (page 238)
+of *The Go Programming Language* (Addison-Wesley, 2016).
+
+# Usage
+
+The following invocation runs the simulation with two players, each of
+which plays with a six-sided die:
+
+`go run . -n 2 -sides 6`
+
+Since 2 and 6 are the default values, in this case the following is
+equivalent:
+
+`go run .`
+
+Of course, `go run . -help` will print a detailed listing of available
+command-line arguments.
+
# The Scene
Several people agree to convene to play a game of dice. Beforehand,
@@ -19,3 +42,4 @@ the case of a tie, the first one to roll the winning number wins. For
example, if player 1 hits the number in three turns, then player 2
hits the number in two turns, then player 3 also in two turns, player
2 wins.
+