stephancom/battleship

# Battleship [![Build Status](https://travis-ci.org/stephancom/battleship.svg?branch=master)](https://travis-ci.org/stephancom/battleship) [![Maintainability](https://api.codeclimate.com/v1/badges/dcbc210c6d9edf4d028b/maintainability)](https://codeclimate.com/github/stephancom/battleship/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/dcbc210c6d9edf4d028b/test_coverage)](https://codeclimate.com/github/stephancom/battleship/test_coverage)

in fulfillment of a code challenge

# Spec

The well-known game of *Battleship*

https://en.wikipedia.org/wiki/Battleship_(game)

https://www.hasbro.com/common/instruct/Battleship.pdf

https://www.youtube.com/watch?v=q0qpQ8doUp8

| ship type  | dimensions |
|------------|------------|
| Carrier    | 5x1        |
| Battleship | 4x1        |
| Submarine  | 3x1        |
| Cruiser    | 3x1        |
| PT Boat    | 2x1        |

## Usage

* install gem
* `battleship`

`battleship -h` is available, and explains any additional configurable options.

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Battleship project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/battleship/blob/master/CODE_OF_CONDUCT.md).