From 00b7e7c69fc90c84d2e6e29a53c3f1f168379eb7 Mon Sep 17 00:00:00 2001 From: Colin Jones Date: Tue, 21 Jan 2014 09:02:35 -0600 Subject: [PATCH] Discourage lein 1 use --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4ba9368..e4a1779 100644 --- a/README.md +++ b/README.md @@ -32,17 +32,18 @@ functionality of readline (command-line history, for example). ### Installing dependencies -Dependencies are installed automatically with lein 2, but if you are still -using lein 1 run +Dependencies are installed automatically with lein 2, but if for some reason +you're on lein 1 and can't upgrade, you'll need to run `lein deps` which will download all dependencies you need to run the Clojure koans. +I strongly recommend that you upgrade to lein 2 instead! ### Running the Koans -If you're running from the zipfile or using lein 1, simply run +If you're running from the zipfile, simply run `script/run` on Mac/\*nix @@ -116,13 +117,17 @@ 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, or `lein koan test` on lein2), and -send a pull request. +(`lein koan test`), 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 `resources/koans.clj`, and we'll get them in there! +Please follow the guidelines in +http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html for +commmit messages, and put your code in a feature branch (not master) before +making the pull request. This makes patches easier to review. + 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.