ttt-game/README.md
2021-08-10 14:57:19 +03:00

19 lines
651 B
Markdown

# TTT-game
[![codecov](https://codecov.io/gh/dm1sh/ttt-game/branch/main/graph/badge.svg?token=7GZ4FJ3E4E)](https://codecov.io/gh/dm1sh/ttt-game)
[![Test and Publish](https://github.com/dm1sh/ttt-game/actions/workflows/ci.yml/badge.svg)](https://github.com/dm1sh/ttt-game/actions/workflows/ci.yml)
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.