[incubator-datasketches-characterization] branch master updated: Update Readme with run instructions.

[le...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

leerho pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-datasketches-characterization.git


The following commit(s) were added to refs/heads/master by this push:
     new 9cddc23  Update Readme with run instructions.
9cddc23 is described below

commit 9cddc23c462d447592d886a0c16b3f69a8daefab
Author: Lee Rhodes <le...@users.noreply.github.com>
AuthorDate: Wed Mar 18 18:37:50 2020 -0700

    Update Readme with run instructions.
---
 README.md | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1eb46fb..5cff269 100644
--- a/README.md
+++ b/README.md
@@ -37,7 +37,7 @@ and will change from time-to-time as we grow these characterization suites.
 
 ### [Java Core Javadocs](https://datasketches.apache.org/api/java/snapshot/apidocs/index.html)
 
-## Build Instructions (Java)
+## Build / Run Instructions (Java)
 
 ### JDK8 is required to compile
 This Java classes of this DataSketches component must be compiled using JDK 8.
@@ -63,6 +63,16 @@ See the pom.xml for the top-level dependencies.
 #### Testing
 See the pom.xml file for test dependencies.
 
+### Run
+* The characterization tests are called profiles and are located by type under the directories:
+    * src/main/java/org/apache/datasketches/characterization/&lt;type&gt;/&lt;test&gt;.java
+* These tests have many parameters that are specified in a corresponding configuration ".conf" file located in directories:
+    * src/main/resources/&lt;type&gt;/&lt;test&gt;.conf
+    * One of the parameters specified by the .conf file is the specific "Job Profile" that is to be run using that configuration.
+* It is recommended that you use your IDE and run the test by executing *org.apache.datasketches.job.main(&lt;location of .conf file&gt;). 
+The IDE should resolve all the required dependencies specified by the pom.xml file for you.  With Eclipse, the command is "run as java application".
+IntelliJ should have something similar.  The output is sent to Standard Out.
+
 ## Build Instructions (C++)
 
 ### From within Eclipse


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org