You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datasketches.apache.org by al...@apache.org on 2019/09/04 20:32:12 UTC

[incubator-datasketches-cpp] branch 1.0.x-incubating updated: build instructions and other comments

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

alsay pushed a commit to branch 1.0.x-incubating
in repository https://gitbox.apache.org/repos/asf/incubator-datasketches-cpp.git


The following commit(s) were added to refs/heads/1.0.x-incubating by this push:
     new 95bf495  build instructions and other comments
95bf495 is described below

commit 95bf4959adb52f87a583a68ef936b92bbf45f2bd
Author: AlexanderSaydakov <Al...@users.noreply.github.com>
AuthorDate: Wed Sep 4 13:31:49 2019 -0700

    build instructions and other comments
---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/README.md b/README.md
index c96b123..6fa2de6 100644
--- a/README.md
+++ b/README.md
@@ -5,3 +5,32 @@ Apache DataSketches is an open source, high-performance library of stochastic st
 This code requires C++11. It was tested with GCC 4.8.5 (standard in RedHat at the time of this writing), GCC 8.2.0 and Apple LLVM version 10.0.1 (clang-1001.0.46.4)
 
 This includes Python bindings. For the Python interface, see the README notes in [the python subdirectory](https://github.com/apache/incubator-datasketches-cpp/tree/master/python).
+
+This library was intended to be header-only, but this goal was not fully
+achieved yet with CPC sketch code. This work is in progress.
+
+Building and running unit tests requires CppUnit.
+
+Installing CppUnit on OSX: brew install cppunit
+
+Installing CppUnit on RHEL: yum install cppunit-devel
+
+There are currently two ways of building: using existing make files and generating
+make files using cmake. Exsisting make files might not work on all platforms
+or with all C++ compilers. Generating make files using cmake should solve
+this problem, but it currently requires cmake version 3.12.0 or later that might not
+be readily available as a package on all platforms.
+Installing latest cmake on OSX: brew install cmake
+
+Building and running unit tests using existing make files:
+
+	$ make
+	$ make test
+
+Building and running unit tests using cmake:
+
+	$ mkdir build
+	$ cd build
+	$ cmake ..
+	$ make
+	$ make test


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