Skip to content
Browse files

updated README and changed copyright

  • Loading branch information...
1 parent efda63f commit 414b58ee53cfd81dc8d301a76d48b1dac449e42f @cwensel cwensel committed Feb 24, 2012
Showing with 16 additions and 6 deletions.
  1. +1 −1 LICENSE.txt
  2. +15 −5 README.md
View
2 LICENSE.txt
@@ -1,7 +1,7 @@
License:
- Copyright (c) 2007-2011 Concurrent, Inc. All Rights Reserved.
+ Copyright (c) 2007-2012 Concurrent, Inc. All Rights Reserved.
Project and contact information: http://www.cascading.org/
View
20 README.md
@@ -10,13 +10,17 @@ This distribution includes six Cascading jar files:
* cascading-x.y.z.jar - all relevant Cascading class files and libraries, with a 'lib' folder
* cascading-core-x.y.z.jar - all Cascading Core class files
-* cascading-local-x.y.z.jar - all Cascading local mode class files
+* cascading-local-x.y.z.jar - all Cascading Local mode class files
* cascading-hadoop-x.y.z.jar - all Cascading Hadoop mode class files
* cascading-xml-x.y.z.jar - all Cascading XML operations class files
* cascading-test-x.y.z.jar - all Cascading tests and test utilities
These jars are all available via www.conjars.org.
+Hadoop mode is where the Cascading application should run on a Hadoop cluster.
+
+Local mode is where the Cascading application will run locally in memory without any Hadoop dependenices.
+
## Building:
To build Cascading, run the following in the shell:
@@ -27,11 +31,17 @@ To build Cascading, run the following in the shell:
> gradle build
```
-where `<path to cascading>` is the directory created after cloning or uncompressing the Cascading distribution.
+Cascading currently requires Gradle 1.0-milestone-3 to build.
+
+To use an IDE like IntelliJ, run the following to get all jar dependencies:
+
+```bash
+> gradle ideLibs
+```
-## Using:
+## Using with Apache Hadoop:
-To use Cascading with Hadoop, we suggest stuffing `cascading-core`, `cascading-hadoop`, (optionally) `cascading-xml` jarfiles and all third-party libs into the `lib`folder of your job jar and executing your job via `hadoop jar your.jar <your args>`.
+To use Cascading with Hadoop, we suggest stuffing `cascading-core`, `cascading-hadoop`, (optionally) `cascading-xml` jarfiles and all third-party libs (optionally retrieved by calling `gradle ideLibs`) into the `lib` folder of your job jar and executing your job via `$HADOOP_HOME/bin/hadoop jar your.jar <your args>`.
Note you do not need to put the lib/hadoop jars in your jar as they are already present in your cluster.
@@ -47,4 +57,4 @@ For example, your job jar would look like this (via: `jar -t your.jar`)
Hadoop will unpack the jar locally and remotely (in the cluster) and add any libraries in `lib` to the classpath. This is a feature specific to Hadoop.
-The cascading-x.y.z.jar file is typically used with scripting languages and is completely self contained, but it cannot be added to a jar `lib` folder as Hadoop will no recursively unjar jars.
+The cascading-x.y.z.jar file is typically used with scripting languages and is completely self contained, but it cannot be added to a jar `lib` folder as Hadoop will not recursively unjar jars.

0 comments on commit 414b58e

Please sign in to comment.
Something went wrong with that request. Please try again.