diff options
| author | _ov4 <ov4@ov4.org> | 2026-10-13 14:25:59 +0000 |
|---|---|---|
| committer | _ov4 <ov4@ov4.org> | 2026-10-13 14:25:59 +0000 |
| commit | ff121fcbb461a4d8f768e87128facf32e6272889 (patch) | |
| tree | 12cccac70566d4159c9edeb5270889c6958e9c29 /doc/install.md | |
| parent | 2fc1af63b20ab67683b74e6bb8f2a3edf5ef2a3d (diff) | |
Group language manuals into function and keyword directories
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Diffstat (limited to 'doc/install.md')
| -rw-r--r-- | doc/install.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/install.md b/doc/install.md index 9fe660a..d91b059 100644 --- a/doc/install.md +++ b/doc/install.md @@ -78,7 +78,7 @@ make -C build release The output is `build/cpsc-VERSION-SYSTEM-ARCH.tar.xz`. `VERSION` uses HEAD's commit time in UTC followed by its short ID: `yyyy-mm-dd-hh-mm-ss-commit`. The version is read each time packaging runs. The package uses the current build's -execution mode and contains `cpsc`, `doc/cpsc.1`, `doc/language/*.7`, `install.sh` and `LICENSE`. +execution mode and contains `cpsc`, `doc/cpsc.1`, `doc/language/**/*.7`, `install.sh` and `LICENSE`. Packaging builds the compiler and manual automatically; it requires Git and Pandoc. Use `EMBEDDED` when recipients should not need LLVM or `lli` at run time. @@ -106,7 +106,7 @@ prefix is preserved. To change it, run You can also call `install.ps1` directly. It installs for the current user without administrator rights. Its source directory must contain `cpsc.exe`, -`doc/cpsc.html` and `doc/language/*.html`: +`doc/cpsc.html` and `doc/language/**/*.html`: ```powershell powershell.exe -NoProfile -ExecutionPolicy Bypass -File .\install.ps1 -SourceDir .\build @@ -114,6 +114,7 @@ powershell.exe -NoProfile -ExecutionPolicy Bypass -File .\install.ps1 -SourceDir The default destination is `%LOCALAPPDATA%\Programs\cpsc`: `cpsc.exe` goes in that directory, the command manual goes in `doc`, and syntax manuals go in +`doc/language/function` and `doc/language/keyword`; the overview stays in `doc/language`. The command manual links to the language overview and its pages. The installer adds the directory to the user PATH and creates Start Menu > cpsc > cpsc Help, which opens the manual in the default browser. Open a new terminal afterward; @@ -134,7 +135,7 @@ 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`, `doc/language/*.html`, `install.ps1` and `LICENSE` under one top-level directory. +`doc/cpsc.html`, `doc/language/**/*.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. |
