Permalink
Browse files

Add some high-level README info and include hadoop deps in the top-le…

…vel POM
  • Loading branch information...
jwills committed Nov 18, 2012
1 parent 6760536 commit 66234116b313748fad2bf0ff9b6657e0f36a1a41
Showing with 37 additions and 2 deletions.
  1. +26 −0 README.md
  2. +11 −2 pom.xml
View
@@ -0,0 +1,26 @@
+Introduction
+===============
+CrunchR is an R wrapper for Apache Crunch that allows you to write MapReduce pipelines in R.
+
+Prerequisites
+===============
+For starters, you want to be running Linux-- we're not quite ready for OS X.
+
+To use R Crunch, you need to have the following R packages installed locally:
+* rJava
+* doxygen
+* bitops
+* RProtoBuf
+
+You will also need the protocol buffer compiler, `protoc`, version 2.4.1 installed on your path.
+
+Getting Started
+================
+We're still in the phase of getting everything to play nicely together. You can try everything out
+by running the following:
+
+ cd crunchR
+ ./install-snapshot-rpkg.sh
+
+Assuming that works well, there are some example R scripts under the `examples` directory that
+you can use to test out loading the `crunchR` library and running simple pipelines.
View
13 pom.xml
@@ -64,9 +64,11 @@
</activation>
<properties>
- <crunch-version>0.4.0-incubating-SNAPSHOT</crunch-version>
+ <crunch-version>0.4.0-incubating</crunch-version>
+ <hadoop-version>1.0.4</hadoop-version>
<rJava-version>0.9-3</rJava-version>
<protobuf-version>2.4.1</protobuf-version>
+ <testng-version>5.11</testng-version>
</properties>
</profile>
@@ -178,6 +180,13 @@
</dependency>
+ <!-- Hadoop stuff -->
+ <dependency>
+ <groupId>org.apache.hadoop</groupId>
+ <artifactId>hadoop-client</artifactId>
+ <version>${hadoop-version}</version>
+ </dependency>
+
<!-- R stuff -->
<dependency>
<groupId>org.r-project</groupId>
@@ -196,7 +205,7 @@
<groupId>org.testng</groupId>
<artifactId>testng</artifactId>
<classifier>jdk15</classifier>
- <version>5.11</version>
+ <version>${testng-version}</version>
</dependency>
</dependencies>

0 comments on commit 6623411

Please sign in to comment.