entailz/wry
1
0
Fork 0
forked from wry/wry
Code Pull requests Activity

docs: add book

Browse source
This commit is contained in:
Claude 2026-03-20 19:14:07 +01:00 • committed by Julian Orth
parent c9d6fb9e40
commit d14105eb1a
43 changed files with 7254 additions and 1204 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -2,21 +2,24 @@
[![crates.io](https://img.shields.io/crates/v/jay-compositor.svg)](http://crates.io/crates/jay-compositor)
Jay is a Wayland compositor.
Jay is a Wayland compositor for Linux with an i3-like tiling layout,
Vulkan and OpenGL rendering, multi-GPU support, screen sharing, and more.
![screenshot.png](static/screenshot.png)
## Features
## Quick Start
See [features.md](./docs/features.md).
```shell
~$ cargo install --locked jay-compositor
~$ jay run
```
## Configuration
See the **[Jay Book](https://mahkoh.github.io/jay/book)** for detailed
installation instructions (including dependencies), configuration,
features, and more.
See [config.md](./docs/config.md).
## Building and Setup
See [setup.md](./docs/setup.md).
The auto-generated [Configuration Spec](./toml-spec/spec/spec.generated.md)
provides an exhaustive reference of every TOML config option.
## License