diff options
Diffstat (limited to 'ark/README.md')
| -rw-r--r-- | ark/README.md | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/ark/README.md b/ark/README.md index d773e0d..a8be7e1 100644 --- a/ark/README.md +++ b/ark/README.md @@ -1,35 +1,35 @@ Ark (Runtime) ============= -Ark is a long-running Wayland compositor runtime with a hot-reloadable soul +Ark is a long-running Wayland compositor runtime with a hot-reloadable world interface. Responsibilities ---------------- - Owns the Wayland display lifecycle and wlroots setup. -- Loads a soul shared object (`.so`) at runtime and routes input/surface events to it. -- Supports hot-reloading the soul without restarting the compositor. +- Loads a world shared object (`.so`) at runtime and routes input/surface events to it. +- Supports hot-reloading the world without restarting the compositor. -Soul interface +World interface -------------- -The runtime defines a C ABI that souls must implement (load/start/teardown, +The runtime defines a C ABI that worlds must implement (load/start/teardown, event handlers, and optional state marshal/unmarshal for hot reload). The ABI is defined in: -- `ark/include/soul.h` +- `ark/include/world.h` -Souls should include: +Worlds should include: -- `ark/include/soul_interface.h` +- `ark/include/world_interface.h` Key files --------- -- `ark/src/wl.c`: compositor setup + event loop + soul callbacks. -- `ark/src/soul.c`: dynamic loading, lifecycle, and hot-reload logic. -- `ark/include/soul.h`: C ABI the soul must implement. +- `ark/src/wl.c`: compositor setup + event loop + world callbacks. +- `ark/src/world.c`: dynamic loading, lifecycle, and hot-reload logic. +- `ark/include/world.h`: C ABI the world must implement. Building -------- @@ -44,7 +44,7 @@ cmake --build ../build --target ark Running ------- -Use the top-level `run` target (builds the bundled soul and launches Ark): +Use the top-level `run` target (builds the bundled world and launches Ark): ```sh cmake --build ../build --target run |