From 8549bd922313305ab6ab0a6ae279b34c84e1f0e6 Mon Sep 17 00:00:00 2001
From: Roland Conybeare <rconybeare@gmail.com>
Date: Mon, 17 Jun 2024 18:22:17 -0400
Subject: [PATCH] xo-unit: README: update to mention xo-build

---
 CMakeLists.txt |  3 ---
 README.md      | 55 ++++++++++++++++++++++++++++++++------------------
 2 files changed, 35 insertions(+), 23 deletions(-)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 6cfe5a99..50e70f0b 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -22,9 +22,6 @@ add_definitions(${PROJECT_CXX_FLAGS})
 add_subdirectory(example)
 add_subdirectory(utest)
 
-# ----------------------------------------------------------------
-# provide find_package() support for projects using this library
-
 set(SELF_LIB xo_unit)
 xo_add_headeronly_library(${SELF_LIB})
 xo_install_library4(${SELF_LIB} ${PROJECT_NAME}Targets)
diff --git a/README.md b/README.md
index 228f14b8..66792cea 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 Provides compile-time dimension checking and scaling.
 
-Similar to `boost::units`,  but:
+Similar in spirit to `boost::units`,  but:
 1. streamlined: assumes modern (c++20) support
 2. supports fractional dimensions (rational powers)
 
@@ -39,27 +39,41 @@ double x = a2.scale();
 
 See [full install instructions](https://rconybea.github.io/web/xo-unit/html/install.html) for other installation strategies.
 
-### build + install upstream dependencies
+### build + install `xo-cmake` dependency
 
 - [github/Rconybea/xo-cmake](https://github.com/Rconybea/xo-cmake)
-- [github/Rconybea/xo-flatstring](https://github.com/Rconybea/xo-flatstring)
-- [github/Rconybea/xo-ratio](https://github.com/Rconybea/xo-ratio)
 
-(Below assumes they're installed using some common value for `PREFIX`)
+Installs a few cmake ingredients,  along with build assistant `xo-build` for XO projects such as this one.
 
-### fetch xo-unit
+### build + install other XO dependencies
+```
+$ xo-build --clone --configure --build --install xo-flatstring
+$ xo-build --clone --configure --build --install xo-ratio
+```
+
+Note: can use `-n` to dry-run here
+
+### copy  `xo-unit` repository locally
+```
+$ xo-build --clone xo-unit
+```
+
+or equivalently
 ```
-$ cd ~/proj
 $ git clone https://github.com/rconybea/xo-unit
 ```
 
-### build + install
+### build + install `xo-unit`
+```
+$ xo-build --configure --build --install xo-unit
+```
+
+or equivalently:
 ```
-$ cd xo-unit
 $ PREFIX=/usr/local  # or wherever you prefer
-$ cmake -DCMAKE_INSTALL_PREFIX=${PREFIX} -S . -B .build
-$ cmake --build .build -j
-$ cmake --install .build
+$ cmake -DCMAKE_INSTALL_PREFIX=${PREFIX} -S xo-unit -B xo-unit/.build
+$ cmake --build xo-unit/.build -j
+$ cmake --install xo-unit/.build
 ```
 
 ### build documentation
@@ -71,24 +85,25 @@ When this completes,  can point local browser to `xo-unit/.build/docs/sphinx/ind
 
 ### build for unit test coverage
 
-Note that unit tests involve additional dependencies:
-- [github/Rconybea/xo-indentlog](https://github.com/Rconybea/indentlog)
-- [github/Rconybea/xo-randomgen](https://github.com/Rconybea/randomgen)
+(Note that unit tests involve additional dependencies):
+```
+$ xo-build --clone --configure --build --install xo-indentlog
+$ xo-build --clone --configure --build --install xo-randomgen
+```
 
 ```
-$ cd xo-unit
-$ mkdir .build-ccov
-$ cmake -DCMAKE_BUILD_TYPE=coverage -DCMAKE_INSTALL_PREFIX=${PREFIX} -DENABLE_TESTING=1 -B .build-ccov
+$ cmake -DCMAKE_BUILD_TYPE=coverage -DCMAKE_INSTALL_PREFIX=$PREFIX -DENABLE_TESTING=1 xo-unit/.build-ccov
+$ cmake --build xo-unit/.build-ccov
 ```
 
 run coverage-enabled unit tests:
 ```
-$ cmake --build .build-ccov -- test
+$ cmake --build xo-unit/.build-ccov -- test
 ```
 
 generate html+text coverage report:
 ```
-$ .build-ccov/gen-ccov
+$ xo-unit/.build-ccov/gen-ccov
 ```
 To see coverage,  can point local browser to `xo-unit/.build-ccov/ccov/html/index.html`