This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/datasketches-cpp.git
The following commit(s) were added to refs/heads/gh-pages by this push:
new 94b335d deploy: 5b1e96890a41d11aff5e4b87eb78fa14155b80d8
94b335d is described below
commit 94b335d9e094633256ab542e28135f3226ffa64d
Author: leerho <[email protected]>
AuthorDate: Tue Jan 13 23:09:39 2026 +0000
deploy: 5b1e96890a41d11aff5e4b87eb78fa14155b80d8
---
docs/master/index.html | 54 ++++++++++++++++++++++++++++----------------------
1 file changed, 30 insertions(+), 24 deletions(-)
diff --git a/docs/master/index.html b/docs/master/index.html
index a4c60fc..a452cdb 100644
--- a/docs/master/index.html
+++ b/docs/master/index.html
@@ -72,38 +72,44 @@ $(function() {
<div class="headertitle"><div class="title">Apache DataSketches Core C++
Library Component </div></div>
</div><!--header-->
<div class="contents">
-<div class="textblock"><p><a class="anchor" id="md_README"></a>This is the
core C++ component of the Apache DataSketches library. It contains all of the
key sketching algorithms that are in the Java component and can be accessed
directly from user applications.</p>
-<p>This component is also a dependency of other components of the library that
create adaptors for target systems, such as PostgreSQL.</p>
-<p>Note that we have a parallel core component for [Java]((<a
href="https://github.com/apache/datasketches-java";>https://github.com/apache/datasketches-java</a>)
and [Python]((<a
href="https://github.com/apache/datasketches-python";>https://github.com/apache/datasketches-python</a>)
implementations of the same sketch algorithms.</p>
+<div class="textblock"><p><a class="anchor" id="md_README"></a> This is the
core C++ component of the Apache DataSketches library. It contains all the key
sketching algorithms from the Java implementation and can be accessed directly
by user applications.</p>
+<p>This component is also a dependency of other library components that create
adaptors for target systems, such as <a
href="https://github.com/apache/datasketches-postgresql";>PostgreSQL</a>.</p>
+<p>Note that we have parallel core library components for Java, Python, and GO
implementations of many of the same sketch algorithms:</p>
+<ul>
+<li><a
href="https://github.com/apache/datasketches-java";>datasketches-java</a></li>
+<li><a
href="https://github.com/apache/datasketches-python";>datasketches-python</a></li>
+<li><a
href="https://github.com/apache/datasketches-go";>datasketches-go</a></li>
+</ul>
<p>Please visit the main <a href="https://datasketches.apache.org";>Apache
DataSketches website</a> for more information.</p>
-<p>If you are interested in making contributions to this site please see our
<a href="https://datasketches.apache.org/docs/Community/";>Community</a> page
for how to contact us.</p>
+<p>If you are interested in making contributions to this site, please see our
<a href="https://datasketches.apache.org/docs/Community/";>Community</a> page
for how to contact us.</p>
<hr />
<p>This code requires C++11.</p>
-<p>This library is header-only. The build process provided is only for
building unit tests.</p>
-<p>Building the unit tests requires cmake 3.12.0 or higher.</p>
-<p>Installing the latest cmake on OSX: brew install cmake</p>
-<p>Building and running unit tests using cmake for OSX and Linux:</p>
-<div class="fragment"><div class="line">$ cmake -S . -B build/Release
-DCMAKE_BUILD_TYPE=Release</div>
-<div class="line">$ cmake --build build/Release -t all test</div>
-</div><!-- fragment --><p>Building and running unit tests using cmake for
Windows from the command line:</p>
-<div class="fragment"><div class="line">$ cd build</div>
-<div class="line">$ cmake ..</div>
-<div class="line">$ cd ..</div>
-<div class="line">$ cmake --build build --config Release</div>
-<div class="line">$ cmake --build build --config Release --target
RUN_TESTS</div>
-</div><!-- fragment --><p>To install a local distribution (OSX and Linux), use
the following command. The CMAKE_INSTALL_PREFIX variable controls the
destination. If not specified, it defaults to installing in /usr (/usr/include,
/usr/lib, etc). In the command below, the installation will be in
/tmp/install/DataSketches (/tmp/install/DataSketches/include,
/tmp/install/DataSketches/lib, etc)</p>
-<div class="fragment"><div class="line">$ cmake -S . -B build/Release
-DCMAKE_BUILD_TYPE=Release
-DCMAKE_INSTALL_PREFIX=/tmp/install/DataSketches</div>
-<div class="line">$ cmake --build build/Release -t install</div>
-</div><!-- fragment --><p>To generate an installable package using cmake's
built in cpack packaging tool, use the following command. The type of packaging
is controlled by the CPACK_GENERATOR variable (semi-colon separated list).
Cmake usually supports packaging types such as RPM, DEB, STGZ, TGZ, TZ, ZIP,
etc.</p>
-<div class="fragment"><div class="line">$ cmake3 -S . -B build/Release
-DCMAKE_BUILD_TYPE=Release -DCPACK_GENERATOR="RPM;STGZ;TGZ" </div>
-<div class="line">$ cmake3 --build build/Release -t package</div>
-</div><!-- fragment --><p>The DataSketches project can be included in other
projects' CMakeLists.txt files in one of two ways. If DataSketches has been
installed on the host (using an RPM, DEB, "make install" into /usr/local, or
some way, then CMake's <code>find_package</code> command can be used like
this:</p>
+<p>This library is header-only. The provided build process is only for unit
tests.</p>
+<p>Building the unit tests requires CMake 3.12.0 or higher.</p>
+<p>Installing the latest CMake on OSX: <code>brew install cmake</code>.</p>
+<p>Building and running unit tests using CMake for OSX and Linux:</p>
+<div class="fragment"><div class="line">cmake -S . -B build/Release
-DCMAKE_BUILD_TYPE=Release</div>
+<div class="line">cmake --build build/Release -t all test</div>
+</div><!-- fragment --><p>Building and running unit tests using CMake for
Windows from the command line:</p>
+<div class="fragment"><div class="line">cd build</div>
+<div class="line">cmake ..</div>
+<div class="line">cd ..</div>
+<div class="line">cmake --build build --config Release</div>
+<div class="line">cmake --build build --config Release --target RUN_TESTS</div>
+</div><!-- fragment --><p>To install a local distribution (OSX and Linux), use
the following command. The <code>CMAKE_INSTALL_PREFIX</code> variable controls
the destination. If not specified, it defaults to installing in /usr
(/usr/include, /usr/lib, etc). In the command below, the installation will be
in /tmp/install/DataSketches (/tmp/install/DataSketches/include,
/tmp/install/DataSketches/lib, etc).</p>
+<div class="fragment"><div class="line">cmake -S . -B build/Release
-DCMAKE_BUILD_TYPE=Release
-DCMAKE_INSTALL_PREFIX=/tmp/install/DataSketches</div>
+<div class="line">cmake --build build/Release -t install</div>
+</div><!-- fragment --><p>To generate an installable package using CMake's
built-in cpack packaging tool, use the following command. The type of packaging
is controlled by the <code>CPACK_GENERATOR</code> variable (semi-colon
separated list). CMake usually supports packaging formats such as RPM, DEB,
STGZ, TGZ, TZ, and ZIP.</p>
+<div class="fragment"><div class="line">cmake -S . -B build/Release
-DCMAKE_BUILD_TYPE=Release -DCPACK_GENERATOR="RPM;STGZ;TGZ" </div>
+<div class="line">cmake --build build/Release -t package</div>
+</div><!-- fragment --><p>The DataSketches project can be included in other
projects' CMakeLists.txt files in one of two ways.</p>
+<p>If DataSketches has been installed on the host (using an RPM, DEB, "make
install" into /usr/local, or some way, then CMake's <code>find_package</code>
command can be used like this:</p>
<div class="fragment"><div class="line">find_package(DataSketches 3.2
REQUIRED)</div>
<div class="line">target_link_library(my_dependent_target PUBLIC
${DATASKETCHES_LIB})</div>
</div><!-- fragment --><p>When used with find_package, DataSketches exports
several variables, including</p>
<ul>
<li><code>DATASKETCHES_VERSION</code>: The version number of the datasketches
package that was imported.</li>
-<li><code>DATASKETCHES_INCLUDE_DIR</code>: The directory that should be added
to access DataSketches include files. Because cmake automatically includes the
interface directories for included target libraries when using
<code>target_link_library</code>, under normal circumstances there will be no
need to include this directly.</li>
+<li><code>DATASKETCHES_INCLUDE_DIR</code>: The directory that should be added
to access DataSketches include files. Because CMake automatically includes the
interface directories for included target libraries when using
<code>target_link_library</code>, under normal circumstances, there will be no
need to include this directly</li>
<li><code>DATASKETCHES_LIB</code>: The name of the DataSketches target to
include as a dependency. Projects pulling in DataSketches should reference this
with <code>target_link_library</code> in order to set up all the correct
dependencies and include paths.</li>
</ul>
<p>If you don't have DataSketches installed locally, dependent projects can
pull it directly from GitHub using CMake's <code>ExternalProject</code> module.
The code would look something like this:</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
