keleusma 0.1.1

Total Functional Stream Processor with definitive WCET and WCMU verification, targeting no_std + alloc embedded scripting
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

# Keleusma Documentation

> A Total Functional Stream Processor that compiles to bytecode.

This documentation is structured as a **knowledge graph** encoded in the file system. Each file contains one atomic concept. Navigate by following links from section indexes.

## Sections

| Section | Path | Description |
|---------|------|-------------|
| Guide | [guide/](./guide/README.md) | Onboarding for new users and embedders |
| Architecture | [architecture/](./architecture/README.md) | Language design and compilation pipeline |
| Design | [design/](./design/README.md) | Grammar, type system, standard library |
| Decisions | [decisions/](./decisions/README.md) | Resolved, priority, and backlog decisions |
| Process | [process/](./process/README.md) | Development workflow and task tracking |
| Reference | [reference/](./reference/README.md) | Glossary, instruction set |
| Roadmap | [roadmap/](./roadmap/README.md) | Development phases |

## Quick Reference

| If you need... | Start here |
|----------------|------------|
| First-time setup and a working example | [guide/GETTING_STARTED.md](./guide/GETTING_STARTED.md) |
| Embedding Keleusma in a Rust host | [guide/EMBEDDING.md](./guide/EMBEDDING.md) |
| A program rejected by the verifier | [guide/WHY_REJECTED.md](./guide/WHY_REJECTED.md) |
| Language overview | [architecture/LANGUAGE_DESIGN.md](./architecture/LANGUAGE_DESIGN.md) |
| Formal grammar | [design/GRAMMAR.md](./design/GRAMMAR.md) |
| Type system | [design/TYPE_SYSTEM.md](./design/TYPE_SYSTEM.md) |
| Built-in functions | [design/STANDARD_LIBRARY.md](./design/STANDARD_LIBRARY.md) |
| Compilation pipeline | [architecture/COMPILATION_PIPELINE.md](./architecture/COMPILATION_PIPELINE.md) |
| Bytecode instructions | [reference/INSTRUCTION_SET.md](./reference/INSTRUCTION_SET.md) |
| Design decisions | [decisions/RESOLVED.md](./decisions/RESOLVED.md) |
| Open questions | [decisions/PRIORITY.md](./decisions/PRIORITY.md) |
| Current task | [process/TASKLOG.md](./process/TASKLOG.md) |
| Terminology | [reference/GLOSSARY.md](./reference/GLOSSARY.md) |
| Related work and citations | [reference/RELATED_WORK.md](./reference/RELATED_WORK.md) |
| Development roadmap | [roadmap/README.md](./roadmap/README.md) |
| Standalone scripts to run | [`examples/scripts/`](../examples/scripts) |
| Rust embedding examples | [`examples/`](../examples) |
| End-to-end SDL3 audio demo with hot swap | [`examples/piano_roll.rs`](../examples/piano_roll.rs) |

## Meta

See [DOCUMENTATION_STRATEGY.md](./DOCUMENTATION_STRATEGY.md) for conventions and navigation guidance.