Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

editing

  • Loading branch information...
commit 2fc4af5d14376a7dfc6ac781330833ec2852a845 1 parent 115db28
@russolsen authored
Showing with 35 additions and 33 deletions.
  1. +35 −33 README.textile
View
68 README.textile
@@ -14,39 +14,9 @@ h2. Installing Dejour
*Step two* is to unpack Dejour. You will end up with a directory with a name like @dejour-1.1.0@. Inside that directory is a bin directory, containing a Linux/Mac script, clj as well as a couple of Windows executables. If you are running on Linux or a Mac, you can run clojure by running the clj script. If you are on windows you have a choice of clj.exe which will run clojure with a console or cljw.exe which will run clojure without a console.
-There is no step three.
+*Step three* is probably to put the dejour @bin@ directory on your your path.
-h2. Using the clj script
-
-If you run the script with no parameters, clj will bring up the interactive clojure 'interpreter': You can simply type in clojure code and immediately see the results. Alternatively, if you supply clj with the name of a clojure script, it will run that script.
-
-The clj script and executable are designed to be very simple for beginners to use, but they are also capable of doing more elaborate things. Here are the arguments that clj understands:
-
- * @-debug@ Just print out the java command and exit.
-
- * @-no-jline@ Don't use jline
-
- * @-no-contrib@ Don't use clojure-contrib
-
- * @-cp <jar or directory>@ Add the next argument to the classpath
-
- * @-classpath <jar or directory>@ Add the next argument to the classpath
-
- * @-Dname=value@ Define the given Java system property, passed directly to java.
-
- * @-Xjava-option@ Passed directly to Java
-
- * @-client@ Use the java client VM
-
- * @-server@ Use the java server VM
-
- * @-hotspot@ Turn on java hotspot
-
- * @-J@ java-option Pass the next argument directly to java.
-
- * @--@ (That's two dashes) Treat everything that follows as a clojure argument
-
-Dejour is also location independant. It will run out of wherever you decide to unpack it -- no environment variables required. The only external dependancy that Dejour has is on Java: It assumes that there is a java command in your path, or that JAVA_HOME is set. If you have both, JAVA_HOME wins.
+*Step four* There is no step four.
h2. Examples
@@ -89,9 +59,41 @@ If you have other java VM arguments, you can pass them in via the -J option:
Dejour also comes with some simple examples of Clojure code from my "Clojure, the least you need to know" talk. You will find these in the examples subdirectory.
+h2. Using the clj script
+
+If you run the script with no parameters, clj will bring up the interactive clojure 'interpreter': You can simply type in clojure code and immediately see the results. Alternatively, if you supply clj with the name of a clojure script, it will run that script.
+
+The clj script and executable are designed to be very simple for beginners to use, but they are also capable of doing more elaborate things. Here are the arguments that clj understands:
+
+ * @-debug@ Just print out the java command and exit.
+
+ * @-no-jline@ Don't use jline
+
+ * @-no-contrib@ Don't use clojure-contrib
+
+ * @-cp <jar or directory>@ Add the next argument to the classpath
+
+ * @-classpath <jar or directory>@ Add the next argument to the classpath
+
+ * @-Dname=value@ Define the given Java system property, passed directly to java.
+
+ * @-Xjava-option@ Passed directly to Java
+
+ * @-client@ Use the java client VM
+
+ * @-server@ Use the java server VM
+
+ * @-hotspot@ Turn on java hotspot
+
+ * @-J@ java-option Pass the next argument directly to java.
+
+ * @--@ (That's two dashes) Treat everything that follows as a clojure argument
+
+Dejour is also location independant. It will run out of wherever you decide to unpack it -- no environment variables required. The only external dependancy that Dejour has is on Java: It assumes that there is a java command in your path, or that JAVA_HOME is set. If you have both, JAVA_HOME wins.
+
h2. Contributors
-Dejour was created by "Russ Olsen":http://github.com/russolsen and is, of course, based on Clojure, clojure-contrib and JLine. Much of the clj script was hamelessly stolen from the Jruby startup script, jruby.sh. Also borrowed some code from Mark Reid's clj script.
+Dejour was created by "Russ Olsen":http://github.com/russolsen and is, of course, based on Clojure, clojure-contrib and JLine. Much of the clj script was hamelessly stolen from the Jruby startup script, jruby.sh. Also borrowed some code from Mark Reid's clj script. Thanks to Fogus for some help with the README file.
See my website at "russolsen.com":http://www.russolsen.com
Please sign in to comment.
Something went wrong with that request. Please try again.