changcl/elixir-koans
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updates Readme

Browse Source
This commit is contained in:
Rabea Gleissner
2016-04-26 10:40:10 +01:00
parent bf1cf2a155
commit f674db1f70
1 changed files with 14 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -2,31 +2,38 @@
[![Build Status](https://travis-ci.org/elixirkoans/elixir-koans.svg?branch=master)](https://travis-ci.org/elixirkoans/elixir-koans) [![Build Status](https://travis-ci.org/elixirkoans/elixir-koans.svg?branch=master)](https://travis-ci.org/elixirkoans/elixir-koans)
Elixir koans is a fun, easy way to get started with the elixir programming language. It is a tour Elixir koans is a fun way to get started with the elixir programming language. It is a tour
of the most important features and idiomatic usage of the language. of the most important features and idiomatic usage of the language.
### Prerequisites ### Prerequisites
To install Elixir, please refer to the [official guide](http://elixir-lang.org/install.html) for instructions. You need to have Elixir installed. Please refer to the [official guide](http://elixir-lang.org/install.html) for instructions.
Next, fetch mix dependencies by running:
To fetch mix dependencies, run:
```sh ```sh
$ mix deps.get $ mix deps.get
``` ```
On Linux, you'll need to install `inotify-tools` if you already haven't to be able You might get prompted to install further dependencies. Reply "y".
On Linux, you'll need to install `inotify-tools` to be able
to use the autorunner in this project. to use the autorunner in this project.
### Running ### Running
With the dependencies installed, just navigate to the root directory of this project and run: With the dependencies installed, navigate to the root directory of this project and run:
```sh ```sh
$ mix meditate $ 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. You should see the first failure. Open the corresponding file in your favourite text editor
and fill in the blanks to make the koans pass one by one.
The autorunner will give you feedback each time you save.
To make the autorunner less noisy, you can start the koans with To make the autorunner less noisy, you can start the koans with
```sh ```sh
$ mix meditate --clear-screen $ mix meditate --clear-screen
``` ```