From 445d881eda847994ca54112802026b2b75d5aeb7 Mon Sep 17 00:00:00 2001
From: Oleksandr Pavlyk <21087696+oleksandr-pavlyk@users.noreply.github.com>
Date: Thu, 24 Jul 2025 10:39:15 -0500
Subject: [PATCH] Expand README

Make it explicit in README that we build and locally install NVBench first,
and then build Python package use the library as a dependency.

The nvbench library is installed into Python layout alongside the native
extension.
---
 python/README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/python/README.md b/python/README.md
index d08a3e6..dffd70e 100644
--- a/python/README.md
+++ b/python/README.md
@@ -19,10 +19,18 @@ Now switch to python folder, configure and install NVBench library, and install
 cd nvbench/python
 cmake -B nvbench_build --preset nvbench-ci -S $(pwd)/.. -DCMAKE_CUDA_COMPILER=/usr/local/cuda/bin/nvcc -DNVBench_ENABLE_EXAMPLES=OFF -DCMAKE_INSTALL_PREFIX=$(pwd)/nvbench_install
 cmake --build nvbench_build/ --config Release --target install
+```
 
+### Build Python extension
+
+Specify location local installation of `NVBench` library and perform editable `pip install`:
+
+```
 nvbench_DIR=$(pwd)/nvbench_install/lib/cmake CUDACXX=/usr/local/cuda/bin/nvcc pip install -e .
 ```
 
+Note that `CUDACXX` must be set for NVBench cmake script to work, but Python extension itself only uses host compiler.
+
 ### Verify that package works
 
 ```