unblock_me_solver

A solver and problem generator for the UnblockMe puzzle game in Elixir


License
MIT

Documentation

UnblockMeSolver

TODO: Add description

Usage

Prefix all commands with

docker run -it --rm -u $(id -u ${USER}):$(id -g ${USER}) -v "$PWD":/usr/src/app -w /usr/src/app elixir

For example

To run the tests

docker run -it --rm -u $(id -u ${USER}):$(id -g ${USER}) -v "$PWD":/usr/src/app -w /usr/src/app elixir mix test

Output:

Start by running

UID=${UID} GID=${GID} docker-compose up

Run commands by prefixing

UID=${UID} GID=${GID} docker-compose exec app

For example. To run the tests

UID=${UID} GID=${GID} docker-compose exec app mix test

To run the tests when a file changes

UID=${UID} GID=${GID} docker-compose exec app mix test.watch

Installation

If available in Hex, the package can be installed by adding unblock_me_solver to your list of dependencies in mix.exs:

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

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/unblock_me_solver.