Merge pull request brianfrankcooper#303 from cmccoy/update-readme

Add build instructions to README, update DB-specific build docs.
wowjason · Jun 17, 2015 · 2973ea5 · 2973ea5
2 parents d871a52 + 423e66f
commit 2973ea5
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -36,3 +36,14 @@ Getting Started
 
   See https://github.com/brianfrankcooper/YCSB/wiki/Core-Properties for 
   the list of available workload properties.
+
+Building from source
+--------------------
+
+To build the full distribution, with all database bindings:
+
+    mvn clean package
+
+To build a single database binding:
+
+    mvn -pl com.yahoo.ycsb:mongodb-binding -am clean package
diff --git a/mongodb/README.md b/mongodb/README.md
@@ -53,7 +53,7 @@ Download the YCSB zip file and compile:
 
     git clone git://github.com/brianfrankcooper/YCSB.git
     cd YCSB
-    mvn -pl com.yahoo.ycsb:core,com.yahoo.ycsb:mongodb-binding clean package
+    mvn -pl com.yahoo.ycsb:mongodb-binding -am clean package
 
 ### 4. Run YCSB
 

diff --git a/redis/README.md b/redis/README.md
@@ -12,7 +12,7 @@ Git clone YCSB and compile:
 
     git clone http://github.com/brianfrankcooper/YCSB.git
     cd YCSB
-    mvn -pl com.yahoo.ycsb:core,com.yahoo.ycsb:redis-binding clean package
+    mvn -pl com.yahoo.ycsb:redis-binding -am clean package
 
 ### 4. Provide Redis Connection Parameters
 
@@ -36,4 +36,4 @@ Load the data:
 Run the workload test:
 
     ./bin/ycsb run redis -s -P workloads/workloada > outputRun.txt
-    
+