aboutsummaryrefslogtreecommitdiff
path: root/montis/README.md
diff options
context:
space:
mode:
authorJosh Rahm <joshuarahm@gmail.com>2026-01-14 00:09:26 -0700
committerJosh Rahm <joshuarahm@gmail.com>2026-01-14 00:11:37 -0700
commitf216280bc0fdc4a6f00187dba1d1ddc22b54097d (patch)
tree64637e9df49011b3ec81738b4347ab7a97e88980 /montis/README.md
parentcc6302ee2073d1ea40608abb77ca6019feca4a2a (diff)
downloadmontis-main.tar.gz
montis-main.tar.bz2
montis-main.zip
[reog] rename soul -> world.HEADmain
It makes a bit more sense.
Diffstat (limited to 'montis/README.md')
-rw-r--r--montis/README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/montis/README.md b/montis/README.md
index cfe264e..f3974c2 100644
--- a/montis/README.md
+++ b/montis/README.md
@@ -1,30 +1,30 @@
-Montis (Haskell Window Manager Soul)
+Montis (Haskell Window Manager World)
====================================
Montis is the hot-reloadable window manager logic for the Ark runtime.
It builds to a shared object (`montis.so`) that Ark loads at runtime. You can
-edit/rebuild the soul and hot-reload it without restarting the compositor.
+edit/rebuild the world and hot-reload it without restarting the compositor.
Native interface
----------------
Montis talks to the runtime through:
-- the soul ABI defined by Ark (`ark/include/soul.h`), implemented in Haskell via
+- the world ABI defined by Ark (`ark/include/world.h`), implemented in Haskell via
`montis/src/Montis/Core/Internal/Foreign/Export.hs` and a small C shim
`montis/src/harness_adapter.c`.
-- the Cross bridge library (`libcross.a`), which provides soul-facing helper
+- the Cross bridge library (`libcross.a`), which provides world-facing helper
functions used via FFI (see `montis/src/Montis/Base/Foreign/Runtime.hs`).
Building
--------
-The soul is built by Stack, typically driven by the top-level CMake build:
+The world is built by Stack, typically driven by the top-level CMake build:
```sh
cmake -S .. -B ../build
-cmake --build ../build --target soul_build
+cmake --build ../build --target world_build
```
Or directly: