From 34d2b75167f1eb8385ac96c7644646791f9dbb2d Mon Sep 17 00:00:00 2001 From: Roland Conybeare Date: Thu, 12 Jun 2025 07:46:39 -0500 Subject: [PATCH] docs: ++ README cover building docs w/ nix --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index e399beb8..73ea5197 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,34 @@ $ tree -L 1 ./result └── xo-bootstrap-macros.cmake ``` +For completeness' sake: can also use +``` +$ nix-build -A xo-userenv-slow +``` + +Same result as `$nix-build -A xo-userenv`, but builds each package serially +using `xo-build`. + +## To view docs from WSL + +1. find wsl IP address + +``` +$ hostname -I +``` + +2. run nix build +``` +$ nix-build -A xo-userenv +``` + +3. serve docs from some available port +``` +$ (cd result && python3 -m http.server 3000) +``` + +4. browse to ":3000/share/doc/xo-flatstring/html" from windows + ## To add a new satellite repo 1. check clone in clean state (all local changes committed or unwound)