aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMosharaf Chowdhury <mosharaf@mosharaf-mbp.(none)>2011-02-09 10:40:23 -0800
committerMosharaf Chowdhury <mosharaf@mosharaf-mbp.(none)>2011-02-09 10:40:23 -0800
commit495b38658e99101240a9b028fd7c2fb8bf1034a4 (patch)
tree89744230fa669231ace88bc5da59e83c142a9177 /README
parenta12c0b6c00eb0c73339beba12eb638c33d472b19 (diff)
parente8df4bbd40817262eeb9dd72f7f0b9a5d81db611 (diff)
downloadspark-495b38658e99101240a9b028fd7c2fb8bf1034a4.tar.gz
spark-495b38658e99101240a9b028fd7c2fb8bf1034a4.tar.bz2
spark-495b38658e99101240a9b028fd7c2fb8bf1034a4.zip
Merge branch 'master' into mos-bt
Diffstat (limited to 'README')
-rw-r--r--README28
1 files changed, 18 insertions, 10 deletions
diff --git a/README b/README
index f084f22a1f..3fbf8c98de 100644
--- a/README
+++ b/README
@@ -1,24 +1,32 @@
+ONLINE DOCUMENTATION
+
+You can find the latest Spark documentation, including a programming guide,
+on the project wiki at http://github.com/mesos/spark/wiki. This file only
+contains basic setup instructions.
+
+
+
BUILDING
-Spark requires Scala 2.8. This version has been tested with 2.8.0.final.
+Spark requires Scala 2.8. This version has been tested with 2.8.1.final.
-To build and run Spark, you will need to have Scala's bin in your $PATH,
-or you will need to set the SCALA_HOME environment variable to point
-to where you've installed Scala. Scala must be accessible through one
-of these methods on Mesos slave nodes as well as on the master.
+The project is built using Simple Build Tool (SBT), which is packaged with it.
+To build Spark and its example programs, run sbt/sbt compile.
-To build Spark and the example programs, run make.
+To run Spark, you will need to have Scala's bin in your $PATH, or you
+will need to set the SCALA_HOME environment variable to point to where
+you've installed Scala. Scala must be accessible through one of these
+methods on Mesos slave nodes as well as on the master.
To run one of the examples, use ./run <class> <params>. For example,
-./run SparkLR will run the Logistic Regression example. Each of the
-example programs prints usage help if no params are given.
+./run spark.examples.SparkLR will run the Logistic Regression example.
+Each of the example programs prints usage help if no params are given.
All of the Spark samples take a <host> parameter that is the Mesos master
to connect to. This can be a Mesos URL, or "local" to run locally with one
thread, or "local[N]" to run locally with N threads.
-Tip: If you are building Spark and examples repeatedly, export USE_FSC=1
-to have the Makefile use the fsc compiler daemon instead of scalac.
+
CONFIGURATION