ttt-game/README.md

16 lines
367 B
Markdown

# Tic Tac Toe
A simple tic tac toe game implementation
## Usage
tic-tac-toe module exports main game class `Game` and `Pl` and `Tr` enums to simplify typing.
### `Game` class
TODO: Add Game class description
### `Pl` and `Tr` Enums
`Pl` has two members: `X` and `O` meaning X and O players. `Tr` enum has all members of `Pl` plus `E` entry meaning empty cell.