You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datasketches.apache.org by le...@apache.org on 2020/01/14 20:27:46 UTC
[incubator-datasketches-characterization] branch master updated:
Update Disclaimer and Readme
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 16b32f8 Update Disclaimer and Readme
16b32f8 is described below
commit 16b32f843aba685f15c57a4f89ce333114be9f91
Author: Lee Rhodes <le...@users.noreply.github.com>
AuthorDate: Tue Jan 14 12:27:32 2020 -0800
Update Disclaimer and Readme
---
DISCLAIMER-WIP | 2 +-
README.md | 37 ++++++++++++++++++++++++++++---------
2 files changed, 29 insertions(+), 10 deletions(-)
diff --git a/DISCLAIMER-WIP b/DISCLAIMER-WIP
index c90f3f7..ae9f942 100644
--- a/DISCLAIMER-WIP
+++ b/DISCLAIMER-WIP
@@ -15,7 +15,7 @@ un-reviewed licensing conditions. What follows is a list of known
issues the project is currently aware of (note that this list, by
definition, is likely to be incomplete):
- * The LICENSE and NOTICE files may not be complete and will be fixed with the next release.
+ * No issues are known at this time.
If you are planning to incorporate this work into your
product or project, please be aware that you will need to conduct a
diff --git a/README.md b/README.md
index e1b17a3..a7ef1ff 100644
--- a/README.md
+++ b/README.md
@@ -17,19 +17,30 @@
under the License.
-->
-# Characterization
-We define characterization as the task of comprehensively measuring accuracy or speed performance of our library. These characterization tests are often long running (some can run for days) and very resource intensive, which makes them unsuitable for including in unit tests. The code in this repository are some of the test suites we use to create some of the plots on our website and provide evidence for our speed and accuracy claims. This code is shared here so that others can duplicat [...]
-
-The code here is shared "as-is" and does not pretend to have the same level of quality as the primary repositories (java, pig, hive and vector). This code is not archived to Maven Central and will change from time-to-time as we grow these characterization suites.
+# Characterization Java & C++ Component
+We define characterization as the task of comprehensively measuring accuracy
+or speed performance of our library. These characterization tests are often long running
+(some can run for days) and very resource intensive, which makes them unsuitable for including
+in unit tests. The code in this repository are some of the test suites we use to create
+some of the plots on our website and provide evidence for our speed and accuracy claims.
+This code is shared here so that others can duplicate our own characterizations.
+
+The code here is shared "as-is" and does not pretend to have the same level of quality as the
+primary repositories (java, pig, hive and vector). This code is not archived to Maven Central
+and will change from time-to-time as we grow these characterization suites.
## Documentation
-### [DataSketches Library Website](https://datasketches.github.io/)
+### [DataSketches Library Website](https://datasketches.apache.org/)
+
+### [Java Core Overview](https://datasketches.apache.org/docs/TheChallenge.html)
+
+### [Java Core Javadocs](https://datasketches.apache.org/api/java/snapshot/apidocs/index.html)
-## Build Instructions
+## Build Instructions (Java)
-### JDK8 is Required Compiler
-This DataSketches component is pure Java and you must compile using JDK 8.
+### JDK8 is required to compile
+This Java classes of this DataSketches component must be compiled using JDK 8.
### Recommended Build Tool
This DataSketches component is structured as a Maven project and Maven is the recommended Build Tool.
@@ -52,9 +63,17 @@ See the pom.xml for the top-level dependencies.
#### Testing
See the pom.xml file for test dependencies.
+## Build Instructions (C++)
+
+### From within Eclipse
+1. After your project is created, from "Project Properties"
+2. From the Eclipse C++ Build Menu, check "Generate Makefiles automatically".
+3. Under "Settings", select "Compiler", then "Includes" and add incude directories for the appropriate sketches and common.
+4. Under "Optimization" select "-O3" and "-DNDEBUG".
+
## Resources
-### [Issues for datasketches-checkstyle](https://github.com/apache/incubator-datasketches-checkstyle/issues)
+### [Issues for datasketches-characterization](https://github.com/apache/incubator-datasketches-characterization/issues)
### [Forum](https://groups.google.com/forum/#!forum/sketches-user)
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org