balkian/clojure-koans
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
977e998592
clojure-koans/README.md
Colin Jones b9575318a9 Use syntax highlighting for README
2011-09-24 12:45:43 -05:00

4.9 KiB
Raw Blame History

Clojure Koans

The Clojure Koans are a fun and easy way to get started with Clojure - no experience assumed or required. Just follow the instructions below to start making tests pass!

Getting Started

The easiest and fastest way to get the koans up and running is to download the latest zip file from Github. This way, you'll have all the dependencies you need, including Clojure itself and JLine, and you can skip the rest of this section (skip to "Running the Koans").

If you're starting from a cloned or forked repo, that's cool too. This way you'll be able to track your progress in Git, and see how your answers compare to others, by checking out the project's Network tab. You might want to create 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.

The only things you'll need to run the Clojure Koans are:

clojure-1.3.0-RC0.jar needs to be in a directory lib under this project.

You can use Leiningen to automatically install the Clojure jar in the right place. Leiningen will also get you a couple more jarfiles, including JLine, which allows you some of the functionality of readline (command-line history, for example).

After you have leiningen installed, run

lein deps

which will download all dependencies you need to run the Clojure koans.

Running the Koans

To run the koans, simply run

script/run on Mac/*nix

script\run on Windows

It's an auto-runner, so as you save your files with the correct answers, it will advance you to the next koan or file.

You'll see something like this:

Problem in  /home/colin/Projects/clojure-koans/src/koans/equalities.clj
---------------------
Assertion failed!
We shall contemplate truth by testing reality, via equality.
(= __ true)

The output is telling you that you have a failing test in equalities.clj. So open that file up and make it pass! In general, you just fill in the blanks to make tests pass. Sometimes there are several (or even an infinite number) of correct answers: any of them will work in these cases.

The koans differ from normal TDD in that the tests are already written for you, so you'll have to pay close attention to the failure messages, because up until the very end, making a test pass just means that the next failure message comes up.

While it might be easy (especially at first) to just fill in the blanks making things pass, you should work thoughtfully, making sure you understand why the answer is what it is. Enjoy your path to Clojure enlightenment!

Trying more things out

There's a REPL (Read-Evaluate-Print Loop) included in the Clojure Koans. Just run:

script/repl on Mac/*nix

script\repl on Windows

Here are some interesting commands you might try, once you're in a running REPL:

(find-doc "vec")
(find-doc #"vec$")
(doc vec)

And if those still don't make sense:

(doc doc)
(doc find-doc)

will show you what those commands mean.

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

Contributing

Patches are encouraged! Make sure the answer sheet still passes (script/test, or script\test on Windows), and send a pull request.

The file ideaboard.txt has lots of good ideas for new koans to start, or things to add to existing koans. So write some fun exercises, add your answers to src/path_to_answer_sheet.clj, and we'll get them in there!

Feel free to contact me (Colin Jones / trptcolin) on Github or elsewhere if you have any questions or want more direction before you start pitching in.

Contributors (in order of appearance)

  • Aaron Bedra
  • Colin Jones (maintainer)
  • Eric Lavigne
  • Nuno Marquez
  • Micah Martin
  • Michael Kohl
  • Ben Lickly
  • Alex Robbins
  • Jaskirat Singh Veen
  • Mark Simpson
  • Mike Jansen
  • Caleb Phillips
  • Doug South

Credits

These exercises were started by Aaron Bedra of Relevance, Inc. in early 2010, as a learning tool for newcomers to functional programming. Aaron's macro-fu makes these koans extremely simple and fun to use, and to improve upon, and without Relevance's initiative, this project would not exist.

Using the koans metaphor as a tool for learning a programming language started with the Ruby Koans by EdgeCase.

License

The use and distribution terms for this software are covered by the Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php) which can be found in the file epl-v10.html at the root of this distribution. By using this software in any fashion, you are agreeing to be bound by the terms of this license.