You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@storm.apache.org by pt...@apache.org on 2014/03/20 22:22:33 UTC

[10/50] [abbrv] git commit: Reformat README

Reformat README


Project: http://git-wip-us.apache.org/repos/asf/incubator-storm/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-storm/commit/84b2eba7
Tree: http://git-wip-us.apache.org/repos/asf/incubator-storm/tree/84b2eba7
Diff: http://git-wip-us.apache.org/repos/asf/incubator-storm/diff/84b2eba7

Branch: refs/heads/master
Commit: 84b2eba70a0c9c6d5a790c0686d0e835bbad8641
Parents: ab44424
Author: Michael G. Noll <mn...@verisign.com>
Authored: Thu Aug 29 11:25:57 2013 +0200
Committer: Michael G. Noll <mn...@verisign.com>
Committed: Thu Aug 29 11:25:57 2013 +0200

----------------------------------------------------------------------
 README.markdown | 35 ++++++++++++++++-------------------
 1 file changed, 16 insertions(+), 19 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-storm/blob/84b2eba7/README.markdown
----------------------------------------------------------------------
diff --git a/README.markdown b/README.markdown
index 0379056..5c21872 100644
--- a/README.markdown
+++ b/README.markdown
@@ -9,41 +9,38 @@ these topologies first:
 
 More information about Storm can be found on the [project page](http://github.com/nathanmarz/storm).
 
+
 ## Running an example with Leiningen
 
-Install Leiningen by following the installation instructions [here](https://github.com/technomancy/leiningen).  The
-storm-starter build uses Leiningen 2.0.
+Install Leiningen by following the [leiningen installation instructions](https://github.com/technomancy/leiningen).
+The storm-starter build uses Leiningen 2.0.
+
 
 ### To run a Java example:
 
-```
-lein deps
-lein compile
-java -cp $(lein classpath) storm.starter.ExclamationTopology
-```
+    $ lein deps
+    $ lein compile
+    $ java -cp $(lein classpath) storm.starter.ExclamationTopology
+
 
 ### To run a Clojure example:
 
-```
-lein deps
-lein compile
-lein run -m storm.starter.clj.word-count
-```
+    $ lein deps
+    $ lein compile
+    $ lein run -m storm.starter.clj.word-count
+
 
 ## Maven
 
-Maven is an alternative to Leiningen. storm-starter contains m2-pom.xml which can be used with Maven using the -f
+Maven is an alternative to Leiningen. storm-starter contains m2-pom.xml which can be used with Maven using the `-f`
 option. For example, to compile and run `WordCountTopology` in local mode, use this command:
 
-```
-mvn -f m2-pom.xml compile exec:java -Dexec.classpathScope=compile -Dexec.mainClass=storm.starter.WordCountTopology
-```
+
+    $ mvn -f m2-pom.xml compile exec:java -Dexec.classpathScope=compile -Dexec.mainClass=storm.starter.WordCountTopology
 
 You can package a jar suitable for submitting to a cluster with this command:
 
-```
-mvn -f m2-pom.xml package
-```
+    $ mvn -f m2-pom.xml package
 
 This will package your code and all the non-Storm dependencies into a single "uberjar" at the path
 `target/storm-starter-{version}-jar-with-dependencies.jar`.