Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
tpoomlmly committed Jul 28, 2021
1 parent b5247c1 commit f60dc8b
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,27 @@
coconut-crack
# Coconut Crack

A simulator for the playground game 'Coconut Crack'.

Prints the players in the order that lose.

## Rules

Players stand in a circle and put 2 fists together into a 'coconut' while a leader bumps their coconut round the circle chanting "Coconut, coconut, coconut, crack".

If the coconut lands on yours on the 'crack' then it cracks into 2 separated fists. A single fist goes behind the back when cracked. If all your coconut pieces are cracked then you're out, and the last person standing wins.

## Usage

`coconut-crack-exe.exe PLAYERS [-c|--coconuts INT] [-p|--pieces INT]`

Available options:

- `PLAYERS` - No. of players in the game
- `-c`, `--coconuts INT` - No. of coconuts before a crack (default: 3)
- `-p`, `--pieces INT` - No. of pieces a coconut cracks into

0 means the coconut is destroyed on the 1st crack (default: 2)

## Compiling

Run `stack build` and the executable will be somewhere in `.stack-work/install`.

0 comments on commit f60dc8b

Please sign in to comment.