Skip to content

Commit

Permalink
Organize README installation/running options
Browse files Browse the repository at this point in the history
  • Loading branch information
trptcolin committed Feb 10, 2017
1 parent d59a8c4 commit 6fc0945
Showing 1 changed file with 38 additions and 25 deletions.
63 changes: 38 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,14 @@ your own branch - that way if you pull back the latest koans from master, it'll
be a bit easier to manage the inevitable conflicts if we make changes to
exercises you've already completed.

You can install the dependencies for the koans (such as Clojure) on your machine,
or you can use Vagrant and the configuration in this repository to have everything
you need set up in a virtual machine.
You have a few options for installation:

### Installation with Vagrant
- Install the dependencies for the koans (such as Clojure) on your machine,
- Use Vagrant and the configuration in this repository
- Use Docker

Make sure you have [Vagrant](https://www.vagrantup.com/) and
[VirtualBox](https://www.virtualbox.org) installed.
In the root directory of the project, execute:
Instructions for each option are below!

vagrant up
vagrant ssh
cd /vagrant
lein koan run

### Installation on Your Machine

Expand All @@ -56,6 +50,39 @@ which will download all dependencies you need to run the Clojure koans.

I strongly recommend that you upgrade to lein 2 instead!


### Installation with Vagrant

Make sure you have [Vagrant](https://www.vagrantup.com/) and
[VirtualBox](https://www.virtualbox.org) installed.
In the root directory of the project, execute:

```
vagrant up
vagrant ssh
cd /vagrant
lein koan run
```


### Installation with Docker

Once you've got [Docker](https://www.docker.com/) installed, you're basically
all set. You can run these commands to get started:

To run koans:

```
docker run --rm -it -v $(pwd):/app -w /app clojure lein koan run
```

To execute REPL:

```
docker run --rm -it -v $(pwd):/app -w /app clojure lein repl
```


## Running the Koans

If you're running from the zipfile, simply run
Expand Down Expand Up @@ -132,20 +159,6 @@ will show you what those commands mean.

You can exit the REPL with `CTRL-d` on any OS.

### Docker

To run koans:

```
docker run --rm -v $(pwd):/app -w /app clojure lein koan run
```

To execute REPL:

```
docker run --rm -it -v $(pwd):/app -w /app clojure lein repl
```

## Contributing

Patches are encouraged! Make sure the answer sheet still passes
Expand Down

0 comments on commit 6fc0945

Please sign in to comment.