Home /Modules/sleela-terminal/BUILD-PLATFORMS.md

BUILD-PLATFORMS.md

sleela-terminal/BUILD-PLATFORMS.md · 81 line(s) · markdown

SleelaTerminal Build and Platform Support

Build the core shell

The default build uses a C++17 compiler and standard build tools:

make clean all
make test
./build/slsh -c 'echo hello'

The default all target builds the CLI and smoke-test executable. It does not require the optional GTK desktop dependencies.

Optional GTK desktop application

On Linux, install GTK4 and VTE 2.91 GTK4 development packages, then run:

make all-gui
# or build just the GUI target
make gui

The GUI target is optional. Its dependencies and runtime behavior are not claimed to be portable to Windows or macOS without separate verification.

Installation

Install the core CLI to the configured prefix (default /usr/local):

make install

Use a user-controlled prefix without administrator privileges:

make install PREFIX="$HOME/.local"

Install the optional GUI and its desktop entry separately:

make install-gui PREFIX="$HOME/.local"

For package staging, set DESTDIR, for example:

make install DESTDIR=/tmp/package-root PREFIX=/usr

Platform support and current limits

Validation gates

The checked-in workflow defines the following automated gates:

GatePlatformWhat it establishes
Clean CLI build + smoke testsUbuntu and macOSBuild and regression checks on the core shell
ASan/UBSan smoke runUbuntuSanitizer coverage for the smoke executable
Clang/libFuzzer buildUbuntuThe fuzz target compiles; this is not a sustained fuzz campaign
Optional GUI buildUbuntuGTK4/VTE GUI compiles against the runner's packages

A workflow definition is not evidence that the latest run passed. Check the repository's Actions page for the run associated with the commit under review.

Release blockers and explicit non-goals

A successful compile is not proof of full POSIX conformance or production readiness. See M5-HARDENING.md and PERFORMANCE.md for outstanding validation gates.