diff options
| author | _ov4 <ov4@ov4.org> | 2026-10-13 04:11:34 +0000 |
|---|---|---|
| committer | _ov4 <ov4@ov4.org> | 2026-10-13 04:11:34 +0000 |
| commit | 46c3c548c6e8b76797b688fbb6aba943a02bf6f1 (patch) | |
| tree | aebe969408c125090770c4bd4f95d3ea243797dd /README.md | |
| parent | 2cd7f7c890803a8dff2a2e9c5e5e24332979d04b (diff) | |
docs: explain installation and commit-versioned releases
Document system and local installation, DESTDIR staging, release contents,
and the UTC commit timestamp and short ID used for package versions.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 46 |
1 files changed, 46 insertions, 0 deletions
@@ -148,6 +148,52 @@ 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. +## Install and release + +On Linux, after configuring and building, install the compiler and manual with: + +```bash +sudo make -C build install +cpsc test.cps -r +man cpsc +``` + +This calls `install.sh` and installs `cpsc` to `/usr/local/bin` and its manual to +`/usr/local/share/man/man1`. Installation generates the manual automatically and +requires Pandoc. Ordinary builds still do not require Pandoc. + +For installation without sudo, set a writable prefix in the existing build: + +```bash +cmake -S . -B build -DCMAKE_INSTALL_PREFIX="$HOME/.local" +make -C build install +export PATH="$HOME/.local/bin:$PATH" +``` + +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: + +```bash +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`, `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. + +Extract the archive with `tar -xJf`, enter the extracted directory, then run +`sudo ./install.sh`, or `./install.sh --prefix "$HOME/.local"` for a local installation. +The package installer does not require CMake, Git or Pandoc. +For a custom prefix, add its `bin` directory to PATH; `man` normally discovers the +adjacent `share/man` directory from PATH. If your man configuration overrides this, +use `man -M "$HOME/.local/share/man" cpsc` for the local prefix. + # 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) |
