From 84cbd5fef8c67586f08cb7396f9d60ef4a07622f Mon Sep 17 00:00:00 2001 From: _ov4 Date: Tue, 13 Oct 2026 05:08:14 +0000 Subject: build: render standalone HTML documentation on Windows Co-Authored-By: Claude Fable 5.1 --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4f14498..939d6f6 100644 --- a/README.md +++ b/README.md @@ -134,7 +134,7 @@ and kept even if execution fails. ## Manual -The command-line quick reference is in `doc/cpsc.md`. Generating the man page requires Pandoc; ordinary builds do not. +The command-line quick reference is in `doc/cpsc.md`. Generating the manual requires Pandoc; ordinary builds do not. From the project root on Linux: @@ -146,7 +146,16 @@ man ./build/doc/cpsc.1 ``` You can also run `make doc` inside the configured `build/` directory. -The output is `build/doc/cpsc.1` and is regenerated when the Markdown source changes. +The output is `build/doc/cpsc.1` on Unix and `build/doc/cpsc.html` on Windows, +and is regenerated when the Markdown source changes. On Windows, install Pandoc, +then generate and open the standalone HTML manual from PowerShell: + +```powershell +cmake --build build --target doc +Start-Process .\build\doc\cpsc.html +``` + +The HTML contains its own styles and can be read offline in a browser. ## Install and release -- cgit v1.3.1-4-g156e