Skip to content
This repository has been archived by the owner on Jul 18, 2020. It is now read-only.

Commit

Permalink
Release 0.2.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
technomancy committed Oct 6, 2013
1 parent 9eab517 commit 958ff11
Showing 1 changed file with 26 additions and 20 deletions.
46 changes: 26 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,11 @@ Fast invocation of Clojure code over nREPL.
<a href="http://achewood.com/index.php?date=04022007">
<img src="comic.gif" align="right"></a>

## Install

You will need to
[install opam](http://opam.ocamlpro.com/doc/Quick_Install.html) and
OCaml 4.x to be able to build Grenchman.

If you're not sure whether you have 4.x installed or not, you can check with:

$ opam switch list
# If your system compiler is 4.x or above, you're ready to go.
# Otherwise, issue the following command:
$ opam switch 4.01.0

To build, run the following commands:

$ git clone git@github.com:technomancy/grenchman.git grenchman
$ cd grenchman
$ opam install ocamlfind core async ctypes
$ ocamlbuild -use-ocamlfind -lflags -cclib,-lreadline grench.native
$ ln -s $PWD/grench.native ~/bin/grench # or somewhere on your $PATH
To install, download the appropriate binary from
http://leiningen.org/grench.html and place it on your path. If
downloads for your platform are not provided you can use the bytecode
version (which requires an OCaml installation) or compile your own;
see "Building" below.

## Usage

Expand Down Expand Up @@ -62,6 +47,27 @@ If you get no output from `grench lein ...` but your Leiningen process
emits an `java.io.FileNotFoundException: project.clj` error message,
upgrading Leiningen should fix it.

## Building

You will need to
[install opam](http://opam.ocamlpro.com/doc/Quick_Install.html) and
OCaml 4.x to be able to build Grenchman.

If you're not sure whether you have 4.x installed or not, you can check with:

$ opam switch list
# If your system compiler is 4.x or above, you're ready to go.
# Otherwise, issue the following command:
$ opam switch 4.01.0

To build, run the following commands:

$ git clone git@github.com:technomancy/grenchman.git grenchman
$ cd grenchman
$ opam install ocamlfind core async ctypes
$ ocamlbuild -use-ocamlfind -lflags -cclib,-lreadline grench.native
$ ln -s $PWD/grench.native ~/bin/grench # or somewhere on your $PATH

## Gotchas

By default Leiningen uses compilation settings which trade long-term
Expand Down

0 comments on commit 958ff11

Please sign in to comment.