Home /Examples/lib/examples/README.md

README.md

lib/examples/README.md · 85 line(s) · markdown

SLeeLa Library Examples

This directory is the learning and demonstration catalogue for the SLeeLa library and its related development tools. Examples are grouped by subsystem; reusable implementation code remains in its owning /lib or /impl directory.

How the catalogue is organized

Each file is named for the concept it teaches. Most subsystem folders now carry a three-step learning progression plus a plain-English guide:

Other name prefixes you will see:

Start with the child-friendly SLeeLa learning path, review SLeeLa's command workflow, then run the classic Hello World.

Nearly every subsystem folder below has a LEARNING-NOTES.md that explains, in simple terms, what the BASIC → MODERATE → ADVANCED examples are for and what you should understand after reading them. The table below links the recommended first example per folder; open the folder's LEARNING-NOTES.md for the guided path.

Example catalogue

DirectoryStarting exampleScope / run notes
sleelaCLASSIC Hello WorldLanguage foundations, loops, methods, arrays, structs, nested classes, imports, and 16 CLI option/workflow examples
sleelvacCompiler invocationSeparate compiler product; confirm options with sleelvac --help
nordshriftCapstone sheetPaired with Ledgerize source; build using the repository's Nordshrift tool
xltEPYC + DDR2 modelValidate with the built xltc tool and current catalog
ballumDisplay frameFrame arithmetic illustration; does not open a native display backend
autocadGeometry primitivesGeometry calculation illustration; does not call AutoCAD APIs
guiLayout boundsParent/child sizing illustration; does not open a GUI window
runtimeThread workersThreads, guarded shared state, mailbox messages, and join
compilerSource validation workflowCheck, compile, and run a source artifact
networkLoopback TCP echoUses local TCP loopback on port 45218
wifiWi-Fi policy smokePolicy/state check; physical radio access requires the native VM bridge
cdmaLink budgetNumerical illustration; no radio transmission
sleela-sqlCreate tableLocal CSV-backed SQL subset; build/test instructions live in /lib/sleela-sql
antivirusIntegrity preflightSHA-256 manifest verification, not a malware scan
cryptoHash integrity workflowDescribes the trusted verifier workflow; not a cryptographic implementation
regexLiteral find draftProposed regex vocabulary; explicitly marked draft
debuggerDebugging checklistReproducible diagnostic workflow
decompilerArtifact inspectionSafe inspection workflow; does not decode an artifact
connectorConnector lifecycleLifecycle illustration; does not contact an external service
javaJava launch preflightPreflight checklist; does not launch a JVM
terminalTerminal menuConsole output example; no interactive input

Running the SLeeLa language examples

After building/installing the runtime, run a source example with:

sleela check lib/examples/sleela/CLASSIC-hello-world.sleela
sleela run lib/examples/sleela/CLASSIC-hello-world.sleela

To create and run a persistent artifact:

sleela compile lib/examples/sleela/CLASSIC-hello-world.sleela -o /tmp/hello.sleela
sleela run /tmp/hello.sleela

Some examples are deliberately contract, policy, or simulation demonstrations. Their comments and this index state when they do not access hardware, external services, or an implemented native bridge. Do not interpret those examples as proof of an integration that the corresponding subsystem README identifies as pending.

Contribution rules