Tic Tac Toe in Elixir!

A library for building/playing a fun Tic Tac Toe game!

Change Log

See the CHANGELOG.md file for further details.

Building Your Own Game

Add :ttt as a dependency to your project's mix.exs with hex package manager(default):

def deps do
  [
    {:ttt, "~> 0.1.0"}
  ]
end

or through GitHub:

def deps do
  [
    {:ttt, git: "https://github.com/mrfishball/TicTacToeElixir.git", tag: "0.1.0"}
  ]
end

And run:

$ mix deps.get

Usage

Visit https://hexdocs.pm/ttt/api-reference.html for documentation on how to use the APIs.

Compiling An Executable

Clone this repo by running:

$ git clone https://github.com/mrfishball/TicTacToeElixir.git

In the root of the project folder, run:

$ mix deps.get

And run:

$ mix escript.build

This will build an executable binary of the game then, simply double click on the new executable file named "ttt" or run:

./ttt

Warnings

Follow these steps to update the dependencies in order to remove any warnings.

rm -rf _build

follow by

mix deps.update --all

then the script in compile step above

Tests

Simply run:

$ mix test

Credo (Optional)

If you like to use Credo to check your code, run:

$ mix credo

Available flags for strict mode and detail mode use:

$ mix credo --strict

and

$ mix credo list

Author

Steven Kwok (@mrfishball)

License

TTT is released under the MIT License. See the LICENSE file for further details.