Skip to content

Commit

Permalink
README doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
manuel-rubio committed Apr 7, 2019
1 parent ae7a460 commit 1f7ed3f
Showing 1 changed file with 18 additions and 12 deletions.
30 changes: 18 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,27 @@
# Leprechaun

**TODO: Add description**
Leprechaun is a game based on [Gems of War](https://gemsofwar.com/), the [Threasure Hunt](https://gemsofwar.zendesk.com/hc/en-us/articles/205368765-Treasure-Hunt-and-Treasure-Maps).

The base of the game is swap pieces, only one each time and only with the ones in north, south, east or west of the source one. The combinations should be made by 3 or more in vertical or horizontal way. If you achieve to match 4 then you won't loose a turn and if you achieve match more than 4 then you'll obtain an extra turn. The game starts with 10 turns and ends when you run out of turns.

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `leprechaun` to your list of dependencies in `mix.exs`:
It's easy to install. You only needs to have [Elixir](https://elixir-lang.org/install.html) installed and run this to obtain the code:

```elixir
def deps do
[
{:leprechaun, "~> 0.1.0"}
]
end
```
git clone git@github.com:altenwald/leprechaun.git
```

Then you can see there are a new directory in that path called `leprechaun`. You can go inside using the terminal and write:

```
iex -S mix run
```

The Elixir shell will be running after the compilation. You can start the game using this command:

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/leprechaun](https://hexdocs.pm/leprechaun).
```elixir
Leprechaun.Game.run
```

Follow the instructions and enjoy!

0 comments on commit 1f7ed3f

Please sign in to comment.