aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
author_ov4 <ov4@ov4.org>2026-10-13 05:13:32 +0000
committer_ov4 <ov4@ov4.org>2026-10-13 05:13:32 +0000
commita6fc1625ea8f825a7161354eb9167a281542fa29 (patch)
treeb610b85c1ca9a94481cfcb1f19ee192508fb9a60 /README.md
parent8b633927930095d2a8f6ffd48dc2f88a21b3e0bf (diff)
build: package Windows releases as ZIP archives
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 26 insertions, 1 deletions
diff --git a/README.md b/README.md
index 35a856f..1155db2 100644
--- a/README.md
+++ b/README.md
@@ -183,7 +183,7 @@ You can also run `./install.sh --source-dir build --prefix "$HOME/.local"`
directly after building `cpsc` and running `make -C build doc`.
`DESTDIR` is supported for staging, for example `DESTDIR=/tmp/cpsc-stage make -C build install`.
-Create an installation archive with:
+On Unix, create an installation archive with:
```bash
make -C build release
@@ -232,6 +232,31 @@ or `-Help` for usage. Windows installation does not support `DESTDIR` staging.
The PowerShell installer targets Windows PowerShell 5.1 or later and has only
been reviewed statically; Windows installation still needs testing on Windows.
+Create a Windows installation archive from the configured MinGW build with:
+
+```powershell
+cmake --build build --target release
+```
+
+This is equivalent to `mingw32-make -C build release`. Windows produces
+`build/cpsc-VERSION-Windows-ARCH.zip`, using the same UTC commit version as Unix
+and retaining the configured execution mode. The ZIP contains `cpsc.exe`,
+`doc/cpsc.html`, `install.ps1` and `LICENSE` under one top-level directory.
+It uses CMake's default Deflate compression and needs no additional compression
+tool; packaging requires Git and Pandoc, just as on Unix.
+
+Extract the ZIP using Windows Explorer, open PowerShell in the extracted package
+directory, then run:
+
+```powershell
+powershell.exe -NoProfile -ExecutionPolicy Bypass -File .\install.ps1
+```
+
+Recipients need neither CMake, Git nor Pandoc to install. To check installation,
+open a new terminal, run `Get-Command cpsc` and compile a source with
+`cpsc test.cps`; open Start Menu > cpsc > cpsc Help to check the manual. Running
+the installer again should leave only one entry for its directory in the user PATH.
+
# Note
DO NOT OPEN ANY ISSUES IF YOU COMPILE WITH VISUAL STUDIO OR ANYTHING EXCEPT MINGW-W64 (EVEN WITH MINGW-W64, WINDOWS IS LIKELY TO BE A PROBLEM MAKER)