Home /Modules/sleela-terminal/INSTALL.md

INSTALL.md

sleela-terminal/INSTALL.md · 131 line(s) · markdown

SLeeLaTerminal™ Installation

Build

From the sleela-terminal directory:

make

The default build is CLI-only and does not require GTK/VTE development packages:

build/slsh
build/smoke

The GUI is optional and uses GTK 4 and VTE. On Debian/Ubuntu systems, install the corresponding GTK 4 and VTE GTK 4 development packages before building it.

To build only the graphical terminal:

make gui

Use make all-gui to build both the CLI and GUI. The gui target builds the GUI only. make test runs the core smoke and M5 shell tests.

Run the GUI

From the sleela-terminal directory:

./build/SleelaTerminal

The GUI opens a dedicated terminal window and starts the SLeeLa shell (slsh) inside a real pseudo-terminal. The window title is SleelaTerminal™ — MEARVK LLC and uses a dark rich-purple title bar.

You may explicitly select a shell executable:

./build/SleelaTerminal ./build/slsh

Test

make test

For AddressSanitizer and UndefinedBehaviorSanitizer validation:

make sanitize

For the Clang/libFuzzer target:

make fuzz

Install

The default installation prefix is /usr/local:

sudo make install

This installs only the CLI shell:

/usr/local/bin/slsh

To separately install the GUI executable and desktop entry, build and install the GUI explicitly:

make install-gui

For both CLI and GUI, run make install-all. Use sudo only when the chosen prefix requires elevated permissions.

The desktop entry launches the GUI as a normal desktop application; it does not open another terminal emulator around SLeeLa.

The installation prefix and binary directory are configurable:

make install PREFIX="$HOME/.local"

or:

make install PREFIX=/opt/sleela

DESTDIR is also supported for staged/package builds.

Install With Stripping

sudo make install-strip

install-strip rebuilds the production targets with the configured compiler flags plus -s and then installs them.

Uninstall

Use the same PREFIX, BINDIR, DESKTOPDIR, and DESTDIR values used for installation:

sudo make uninstall

For a user-local installation:

make uninstall PREFIX="$HOME/.local"

The uninstall target removes the SLeeLa shell, GUI executable, and SLeeLa desktop entry if installed by this Makefile.

Clean

make clean

This removes the generated build/ directory.