From 5e732e35c1aea3a00903aae50f63cf1cf9166833 Mon Sep 17 00:00:00 2001
From: Yilun Chong <yilunchong@google.com>
Date: Tue, 12 Dec 2017 12:05:29 -0800
Subject: Add caliper supported to java benchmark

---
 benchmarks/README.md | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

(limited to 'benchmarks/README.md')

diff --git a/benchmarks/README.md b/benchmarks/README.md
index 0273e389..00a63704 100644
--- a/benchmarks/README.md
+++ b/benchmarks/README.md
@@ -7,6 +7,18 @@ protobuf language runtime.
 
 The schema for the datasets is described in `benchmarks.proto`.
 
+The benchmark is based on some submodules. To initialize the submodues:
+
+For java:
+```
+$ ./initialize_submodule.sh java
+```
+
+For java:
+```
+$ ./initialize_submodule.sh cpp
+```
+
 To run all the benchmark dataset:
 
 For java:
@@ -26,17 +38,24 @@ To run a specific dataset:
 For java:
 
 ```
-$ make java
+$ make java-benchmark
 $ ./java-benchmark $(specific generated dataset file name)
 ```
 
 For cpp:
 
 ```
-$ make cpp
+$ make cpp-benchmark
 $ ./cpp-benchmark $(specific generated dataset file name)
 ```
 
+There's some big testing data not included in the directory initially, you need to 
+run the following command to download the testing data:
+
+```
+$ ./download_data.sh 
+```
+
 Each data set is in the format of benchmarks.proto:
 1. name is the benchmark dataset's name.
 2. message_name is the benchmark's message type full name (including package and message name)
-- 
cgit v1.2.3