vtimofei
/
smithay
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add anvil to the readme

This commit is contained in:
Victor Berger 2018-05-13 15:01:50 +02:00
parent 664327660e
commit 61bb72a016
1 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -4,7 +4,7 @@
[![docs.rs](https://docs.rs/smithay/badge.svg)](https://docs.rs/smithay) [![docs.rs](https://docs.rs/smithay/badge.svg)](https://docs.rs/smithay)
[![Build Status](https://travis-ci.org/Smithay/smithay.svg?branch=master)](https://travis-ci.org/Smithay/smithay) [![Build Status](https://travis-ci.org/Smithay/smithay.svg?branch=master)](https://travis-ci.org/Smithay/smithay)
[![Join the chat on matrix at @smithay:matrix.org](matrix_badge.svg)](https://matrix.to/#/#smithay:matrix.org) [![Join the chat on matrix at @smithay:matrix.org](matrix_badge.svg)](https://matrix.to/#/#smithay:matrix.org)
[![Join the chat via bridge at https://gitter.im/smithay/Lobby](https://badges.gitter.im/smithay/Lobby.svg)](https://gitter.im/smithay/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Join the chat via bridge on gitter at smithay/Lobby ](https://badges.gitter.im/smithay/Lobby.svg)](https://gitter.im/smithay/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
A smithy for rusty wayland compositors A smithy for rusty wayland compositors
@ -16,9 +16,31 @@ functionnalities that pretty much any compositor will need, in a generic fashion
Also: Also:
- **Documented:** Smithay strives to maintain a clear and detailed documentation of its API and its
functionnalities. Compiled documentations are available on [docs.rs](https://docs.rs/smithay) for released
versions, and [here](https://smithay.github.io/smithay) for the master branch.
- **Safety:** Smithay will target to be safe to use, because Rust. - **Safety:** Smithay will target to be safe to use, because Rust.
- **Modularity:** Smithay is not a framework, and will not be constraining. If there is a - **Modularity:** Smithay is not a framework, and will not be constraining. If there is a
part you don't want to use, you should not be forced to use it. part you don't want to use, you should not be forced to use it.
- **High-level:** You should be able to not have to worry about gory low-level stuff (but - **High-level:** You should be able to not have to worry about gory low-level stuff (but
Smithay won't stop you if you really want to dive into it). Smithay won't stop you if you really want to dive into it).
## Anvil
Like others, Smithay as a compositor library has its own sample compositor: anvil.
You can run it with cargo after having cloned this repository:
```
cargo run -p anvil -- --{backend}
```
The currently available backends are:
- `--winit`: start anvil as a [Winit](https://github.com/tomaka/winit) application. This allows you to run it
inside of an other X11 or Wayland session.
- `--tty-udev`: start anvil in a tty with udev support. This is the "traditional" launch of a Wayland
compositor. Note that this requires you to start anvil as root if your system does not have logind
available ([consolekit support is planned](https://github.com/Smithay/smithay/issues/95)).
- `--tty-raw`: start anvil without udev support, manually binding all ressources. Requires to be run as root.
This backend is mostly present as example code for use in very minimalistic systems.