Home /Modules/docs/ORGANIZATION.md

ORGANIZATION.md

docs/reference/ORGANIZATION.md · 82 line(s) · markdown

<img align="right" src="../../images/sleela/sleela-medium-profile-permanent-icon-002.jpg" width="45" height="45" alt="SLeeLa">

SLeeLa — Repository Organization

<p align="center"><img src="https://raw.githubusercontent.com/mearvk/SLeeLa/master/merchandise/sleela-marketing-logo-001.png" alt="SLeeLa Marketing Logo" width="560"></p>

A one-page map of this repository, intended to orient a new contributor or an AI assistant (Kiro, ChatGPT, etc.) quickly. For the full project narrative see README.md; this file is the short structural index.

What this project is

SLeeLa is a Java-like programming language that runs on a Turing-complete, thread-friendly C/C++ execution core. Nordshrift is the .sst transpiler driver layered on top; it drives a triplet of targets (Java, SLeeLa, C). A SLeeLa source file (.sleela) is a Wrapper™ — the program unit governed by the Sleela Language Metadocument (SL-META-0001).

Source of truth — where the canonical definition of each thing lives

TopicCanonical source
.sst sheet format (1.0)SST.model (NS-SST-0001)
.sst semantic layer (2.0)SST-2.0.model
Standard library inventory (/lib)lib/LIBRARY.INDEX.md, lib/LIBRARY.SYMBOLS.md
Architecture overviewmarkdown/ARCHITECTURE.md
Java Specific Section (the Java tier, Java to SLeeLa conversion)lib/java/JAVA.SPEC.md
Compiler + library resolutionmarkdown/COMPILER.md, markdown/COMPILER.RESOLUTION.md
Build systemmarkdown/BUILD.md, impl/BUILD-LAYOUT.md
Native C/C++ designimpl/DESIGN.md
Nordshrift internalsimpl/nordshrift/NORDSHRIFT-COMPLETE.md
XML/DTD interchange formmarkdown/XML.SLEELA.DEFINITION.md, xml-moment/

Top-level map

PathContents
impl/The C/C++ implementation. Execution core, compiler, Nordshrift, OS abstraction layer (impl/core, with POSIX + Win32 backends), subject libraries, native services. Build entry: cd impl && make.
lib/The SLeeLa standard library — the authoritative language-facing .sleela source collection, discovered recursively. Each first-level directory is a package namespace. Inventory in lib/LIBRARY.INDEX.md.
markdown/Reference documentation (architecture, build, compiler, class/library inventories, subject domains, and more).
examples/Worked examples: XML subject models, Nordshrift .sst sheets (examples/nordshrift/), symmetry builds.
xml-moment/XML + DTD interchange form for SLeeLa classes and SST/Nordshrift sheets (see the XML definition doc).
user-interface/SleelaUI™ — SLeeLa's own original cross-platform UI toolkit. C/C++ widget library with a software rasterizer and native backends (X11, Cocoa, Win32); default Slick Black theme. Not GTK/Qt. Build entry: cd user-interface && make.
tools/Generator and verification scripts (SHA-256 manifests, data generation, accuracy checks).
test-suites/ / tests/Test harnesses (C, C++, negative, coverage) and project tests.
scripts/Per-platform build/install helpers (build-linux.sh, build-macos.sh, …).
.github/CI workflows (per-platform builds on every push/PR).
.kiro/Kiro steering files (auto-loaded guidance for the AI assistant).
impl/coreOS-aware abstraction: threads, sockets, files, pipes, paths, terminal, dynamic libs, time. Runtime reports backend as linux / macos / windows.

This repository also contains many domain and content directories (e.g. subject models, HTTP server grades http-1.0…http-9.0, telephony, and policy/data documents). The table above lists the areas most relevant to building and extending the language and tooling; browse the tree or README.md for the rest.

Build & test (quick start)

PlatformCommand
Linuxscripts/build-linux.sh or cd impl && make
macOSscripts/build-macos.sh
Windows 10+build-windows.ps1 (MinGW-w64)

Tests: cd impl && make test. CI runs per-platform builds on every push and pull request (see .github/workflows).

Branches

main and master are both maintained and are kept with equivalent content; changes are applied to both.

Conventions for AI assistants