Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

.

  • Loading branch information...
commit 305e598be284171af084dc2b42de70edc4de404e 1 parent b0121e0
@eduardoejp eduardoejp authored
Showing with 11 additions and 5 deletions.
  1. +9 −4 README.md
  2. +2 −1  project.clj
View
13 README.md
@@ -5,14 +5,19 @@ clj-ripple
clj-ripple is a library for translating Clojure source code into Ripple source code, which can then be executed.
This allows for easy embedding of Ripple into Clojure programs.
+Usage
+-----
+
+Simply add this to your leiningen deps: `[clj-ripple "0.1.0-SNAPSHOT"] `
+
Syntax
------
-The ripple macro takes specially formatted Clojure source code and translates it (using the translate function) into the equivalent Ripple source code.
-It then executes it using the run-ripple function, inside an evironment created with the with-ripple macro, which dynamically binds the `*ripple*` variable
-to a fresh QueryPipe and the `*sink*` variable to a fresh `Collector<T,E>` sink.
+The `ripple` macro takes specially formatted Clojure source code and translates it (using the `translate` function) into the equivalent Ripple source code.
+It then executes it using the `run-ripple` function, inside an evironment created with the `with-ripple` macro, which dynamically binds the `*ripple*` var
+to a fresh `QueryPipe` and the `*sink*` var to a fresh `Collector<T,E>` sink.
-Although all of those components (with-ripple, run-ripple & translate) can be used separately, it is best to simple use the ripple macro.
+Although all of those components (`with-ripple`, `run-ripple` & `translate`) can be used separately, it is best to simple use the `ripple` macro.
The result is return as a Clojure lazy sequence containing all the stacks as sequences.
The topmost elements in the stacks appear first and are followed by the elements at the bottom.
View
3  project.clj
@@ -1,8 +1,9 @@
-(defproject clj-ripple "0.1.0"
+(defproject clj-ripple "0.1.0-SNAPSHOT"
:dependencies [[org.clojure/clojure "1.2.0"]
[org.clojure/clojure-contrib "1.2.0"]
[org.openrdf.sesame/sesame-sail-memory "2.3.3"]
[net.fortytwo.ripple/ripple-blueprints "0.7-SNAPSHOT"]]
+ :dev-dependencies [[lein-clojars "0.6.0"]]
:repositories {"aduna" "http://repo.aduna-software.org/maven2/releases/"
"ripple" "http://fortytwo.net/maven2"}
:namespaces :all)
Please sign in to comment.
Something went wrong with that request. Please try again.