Home /Modules/build/README.md

README.md

build/README.md · 142 line(s) · markdown

<img align="right" src="https://github.com/mearvk/SLeeLa/blob/master/images/debian/debian-logo.png" width="75" height="75" alt="SLeeLa">

<img src="https://github.com/mearvk/SLeeLa/blob/master/images/sleela/sleela-logo-004.jpg" alt="SLeeLa">

SLeeLa Build

The build/ tree documents and hosts product-specific native build entry points. Product source remains authoritative in its product directory; generated output is disposable.

Regex subsystem

The SLeeLa Regex native implementation is under regex/.

From the repository root:

make -C regex test

Focused targets:

make -C regex c make -C regex cpp make -C regex clean

See build/REGEX.md for the build boundary, toolchain notes, output path, and CI conformance target.

Skya Platform Builds

Direct native build entry points for Skya on Linux, Windows 10+, and macOS.

Linux

Requirements: GCC or Clang with C++17 support.

chmod +x build/skya-linux.sh ./build/skya-linux.sh

The script builds build/skya/linux/skya, then asks whether to start the server. Answer y or yes to launch it in the background; the build script returns immediately. Answer n, no, or press Enter to leave it stopped. Non-interactive builds compile Skya without starting the server.

When started, output is redirected to build/skya/linux/skya.log, and the process ID is recorded in build/skya/linux/skya.pid. Set SKYA_ROOM to override the default lobby room.

Windows 10+

Requirements: MinGW-w64 GCC/G++ and PowerShell.

powershell -ExecutionPolicy Bypass -File .\\build\\skya-windows.ps1

Output: build\\skya\\windows\\skya.exe

macOS

Requirements: Xcode Command Line Tools and clang++.

chmod +x build/skya-macos.sh ./build/skya-macos.sh

Output: build/skya/macos/skya

Runtime roles

skya --server --room lobby skya --client --room lobby skya --both --room lobby skya --both --http2 --room lobby skya --both --http3 --room lobby

These scripts build the current native Skya engine directly. The integrated SLeeLa runtime remains the authoritative sleela skya ... path. The current engine is a lifecycle/room foundation; production transport, media, NAT, certificate, file-transfer, and firewall integrations remain documented in SKYA.md.

Slecompiler™ Product Build

Slecompiler is built from the authoritative decompiler/ source tree.

Linux:

chmod +x build/slecompiler-linux.sh
./build/slecompiler-linux.sh

macOS:

chmod +x build/slecompiler-macos.sh
./build/slecompiler-macos.sh

Windows 10+:

powershell -ExecutionPolicy Bypass -File .\\build\\slecompiler-windows.ps1

Product outputs are isolated under build/slecompiler/<platform>/. The build scripts configure the existing CMake project and do not replace Slecompiler source.

See build/PRODUCTS.md for the product-build boundary and planned expansion.

Slecompiler's CMake project is explicitly C++20. The API examples, CLI, tests, and static library are part of the same configured product build; there is no separate example-only toolchain.

Slecompiler verification path

After configuration, the native test suite can be invoked from the generated build directory with CTest. The repository also contains five API exemplars, which provide compile-time coverage of the public usage path. Cross-platform CI and packaged release verification remain future build layers.

Windows 10+ toolchain notes

The Slecompiler Windows entry point uses CMake and PowerShell and does not require a POSIX shell. Visual Studio 2022 can be selected explicitly:

powershell -ExecutionPolicy Bypass -File .\\build\\slecompiler-windows.ps1 -Generator "Visual Studio 17 2022" -Architecture x64

The script also accepts Win32 or ARM64 for Visual Studio generators. CMake-supported MinGW-w64 toolchains remain possible when selected through the CMake environment/generator.

macOS toolchain notes

The Slecompiler macOS entry point requires Xcode Command Line Tools and CMake 3.20+. It defaults to the host architecture and a macOS 11.0 deployment target. Both are configurable:

CMAKE_OSX_ARCHITECTURES="x86_64;arm64" MACOSX_DEPLOYMENT_TARGET=11.0 ./build/slecompiler-macos.sh

This permits a universal macOS build when the installed SDK/toolchain supports both architectures.


SLeeLa

<p align="center"><img src="images/sleela/sleela-wordmark.svg" alt="SLeeLa — The Now. The Ingredient." width="560"></p> <p align="center"><img src="https://github.com/mearvk/SLeeLa/blob/master/images/sleela-programming-language-002.jpg" alt="SLeeLa Marketing Logo" width="560"></p>