cmake

README.md

@@ -6,6 +6,8 @@ KvikIO is a Python and C++ library for high performance file IO. It provides C++
 bindings to [cuFile](https://docs.nvidia.com/gpudirect-storage/api-reference-guide/index.html),
 which enables [GPUDirect Storage (GDS)](https://developer.nvidia.com/blog/gpudirect-storage/).
 KvikIO also works efficiently when GDS isn't available and can read/write both host and device data seamlessly.
+The C++ library is header-only making it easy to include in [existing projects] (https://github.com/rapidsai/kvikio/blob/HEAD/cpp/examples/downstream/).
+
 
 ### Features
 

cpp/doxygen/main_page.md

@@ -56,6 +56,9 @@ mamba create -n libkvikio-env -c rapidsai-nightly -c conda-forge python=3.10 cud
 
 ---
 
+### Include KvikIO in a CMake project
+An example of how to include KvikIO in an existing CMake project can be found here:  <https://github.com/rapidsai/kvikio/blob/HEAD/cpp/examples/downstream/>.
+
 
 ### Build from source
 
@@ -109,3 +112,5 @@ int main()
   }
 }
 ```
+
+For a full runable example see <https://github.com/rapidsai/kvikio/blob/HEAD/cpp/examples/basic_io.cpp>.

docs/source/zarr.rst

@@ -3,7 +3,7 @@ Zarr
 
 KvikIO implements a Zarr-Python backend for reading and writing GPU data to file seamlessly.
 
-The following is An example of how to use the convenience function :py:meth:`kvikio.zarr.open_cupy_array`
+The following is an example of how to use the convenience function :py:meth:`kvikio.zarr.open_cupy_array`
 to create a new Zarr array and how open an existing Zarr array.