Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zoedsoupe authored Jan 14, 2024
1 parent f7fba2e commit 952a77f
Showing 1 changed file with 65 additions and 2 deletions.
67 changes: 65 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,76 @@
## Installing

_TODO_
> ⚠️ cross-platform binaries are not available yet
> I'm having some trouble with the "burrito" lib, check [this issue](https://github.com/burrito-elixir/burrito/issues/117)
For now, you can clone this repo with:
```sh
git clone https://github.com/zoedsoupe/exlings

# or with gh CLI
gh repo clone zoedsoupe/exlings
```

### Dependencies

| name | version |
| elixir | `>= v0.14 |


## Doing exercices

> Currently you can execute these commands into the root dir where you cloned the repo
The exercises are all placed on the `./priv/exercises/*` directory! You can edit them as you want!

To run the exercises in the recommended order while taking advantage of fast feedback loop, use the _watch_ command:

```sh
mix run -- watch
```

This command will run `exlings` in interactive mode. Every time you save a file it will verify if the code is correct.

To run the next pending exercise:

```sh
mix run -- run
```

If you want to run a single exercise:

```sh
mix run -- run 001_hello_world
```

In case you are stuck and need a hint:

```sh
mix run -- hint 001_hello_world
```

To list all exercise while checking your progress:

```sh
mix run -- list
```

To compile and run all the exercises:

```sh
mix run -- verify
```

# Learning resources

_TODO_
- [Elixir official Getting Started](https://hexdocs.pm/elixir/introduction.html)
- [Elixir School](https://elixirschool.com/pt)
- [Elixir official Forum](https://elixirforum.com)

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md)

## Other 'lings

Expand Down

0 comments on commit 952a77f

Please sign in to comment.