Add readme
This commit is contained in:
27
README.md
27
README.md
@@ -1,19 +1,24 @@
|
||||
# Elixir Koans
|
||||
|
||||
**TODO: Add description**
|
||||
Elixir koans is a fun, easy way to get started with the elixir programming language. It is a tour
|
||||
of the most important features and idiomatic usage of the language.
|
||||
|
||||
## Installation
|
||||
### Prerequisites
|
||||
|
||||
If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:
|
||||
The only dependency needed to run these koans is the Elixir language. Please refer to the
|
||||
[official guide](http://elixir-lang.org/install.html) for instructions.
|
||||
|
||||
1. Add elixir_koans to your list of dependencies in `mix.exs`:
|
||||
### Running
|
||||
|
||||
def deps do
|
||||
[{:elixir_koans, "~> 0.0.1"}]
|
||||
end
|
||||
With Elixir installed, just navigate to the root directory of this project and run:
|
||||
```sh
|
||||
$ mix meditate
|
||||
```
|
||||
to get going. You should see the first failure with a blank line in it. The goal is
|
||||
to fill in the blanks and make all the koans pass by doing so.
|
||||
|
||||
2. Ensure elixir_koans is started before your application:
|
||||
### Contributing
|
||||
|
||||
def application do
|
||||
[applications: [:elixir_koans]]
|
||||
end
|
||||
We welcome contributions! If something does not make sense along the way or you feel
|
||||
like an important lesson is missing from the koans, feel free to fork the project
|
||||
and open a pull request.
|
||||
|
Reference in New Issue
Block a user