balkian/clojure-koans
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Organize README installation/running options

Browse Source
This commit is contained in:
Colin Jones 2017-02-10 09:02:31 -06:00
parent d59a8c4659
commit 6fc09456ac
No known key found for this signature in database
GPG Key ID: BB1DBD3616F1DDB9
1 changed files with 38 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
README.md
View File

@ -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 be a bit easier to manage the inevitable conflicts if we make changes to
exercises you've already completed. exercises you've already completed.
You can install the dependencies for the koans (such as Clojure) on your machine, You have a few options for installation:
or you can use Vagrant and the configuration in this repository to have everything
you need set up in a virtual machine.
### 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 Instructions for each option are below!
[VirtualBox](https://www.virtualbox.org) installed.
In the root directory of the project, execute:
vagrant up
vagrant ssh
cd /vagrant
lein koan run
### Installation on Your Machine ### Installation on Your Machine
@ -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! 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 ## Running the Koans
If you're running from the zipfile, simply run If you're running from the zipfile, simply run
@ -132,20 +159,6 @@ will show you what those commands mean.
You can exit the REPL with `CTRL-d` on any OS. 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 ## Contributing
Patches are encouraged! Make sure the answer sheet still passes Patches are encouraged! Make sure the answer sheet still passes