Permalink
Browse files

Update readme.

  • Loading branch information...
1 parent e33ab71 commit 12a2e02549c3c4799964a81100a94db8862c7b64 @technomancy committed Aug 24, 2013
Showing with 28 additions and 4 deletions.
  1. +3 −1 .gitignore
  2. +25 −3 README.md
  3. BIN comic.gif
View
4 .gitignore
@@ -2,4 +2,6 @@ _build
*.byte
/.lein-repl-history
/.nrepl-port
-/target
+/target
+/grench.native
+/.lein-env
View
28 README.md
@@ -1,10 +1,32 @@
# Grenchman
-Fast access to Leiningen over nREPL.
+Fast invocation of Leiningen tasks over nREPL.
-http://achewood.com/index.php?date=04022007
+<a href="http://achewood.com/index.php?date=04022007">
+ <img src="comic.gif" align="right"></a>
-To build, install opam and run `ocamlbuild -use-ocamlfind grench.byte`
+## Install
+
+To build, install [opam](http://opam.ocamlpro.com/) and OCaml 4.01 and run:
+
+ $ ocamlbuild -use-ocamlfind grench.native
+ $ ln -s $PWD/grench.native ~/bin/grench # or somewhere on your $PATH
+
+## Usage
+
+You can use `grench` as a replacement launcher for `lein` for most
+non-interactive tasks. When used together with `:eval-in :nrepl`, you
+can eval Clojure code inside your project in under 0.15 seconds.
+
+Currently requires Leiningen from git master (newer than 2.3.2). It's
+up to you to launch your own Leiningen process separately:
+
+ $ cd ~/.lein && lein repl :headless
+
+Tasks for all projects will share the same Leiningen instance, so
+projects with have conflicting plugins may behave unpredictably.
+
+## License
Copyright © 2013 Phil Hagelberg. Bencode implementation by Prashanth
Mundkur. Licensed under the GNU General Public License, version 3 or
View
BIN comic.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 12a2e02

Please sign in to comment.