ttt-game/README.md

19 lines
568 B
Markdown

# TTT-game
[![codecov](https://codecov.io/gh/dm1sh/tic-tac-toe/branch/main/graph/badge.svg)](https://codecov.io/gh/dm1sh/tic-tac-toe)
![CI](https://github.com/dm1sh/tic-tac-toe/actions/workflows/ci.yaml/badge.svg)
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.