Go to file
Victor Berger b3141ca2dc Add a few badges on the README 2017-10-04 11:30:07 +02:00
examples examples: add output to winit example 2017-10-01 22:47:30 +02:00
src wayland: document general behaviour of the client handlers 2017-10-01 22:47:30 +02:00
.gitignore add vscode to gitignore 2017-09-19 17:02:16 +02:00
.rustfmt.toml First draft of compositor global. 2017-06-23 15:19:27 +02:00
.travis.yml travis: correct doc index location 2017-10-04 11:29:50 +02:00
CHANGELOG.md Version 0.1.0 2017-10-01 23:11:01 +02:00
CONTRIBUTING.md Create CONTRIBUTING.md 2017-04-21 12:01:26 +02:00
Cargo.toml Version 0.1.0 2017-10-01 23:11:01 +02:00
LICENSE.txt Add MIT license 2017-03-24 10:24:07 +01:00
README.md Add a few badges on the README 2017-10-04 11:30:07 +02:00
build.rs cargo fmt 2017-09-20 20:06:58 +02:00
doc_index.html travis: add a redirect doc homepage 2017-10-01 20:34:24 +02:00
matrix_badge.svg Add a few badges on the README 2017-10-04 11:30:07 +02:00

README.md

Smithay

Crates.io docs.rs Build Status Join the chat on matrix at @smithay:matrix.org Join the chat via bridge at https://gitter.im/smithay/Lobby

A smithy for rusty wayland compositors

Warning: This is a very new project, still in the process of shaping itself. I cannot recommend to use it unless you want to help driving it forward. ;-)

Goals

Smithay aims to provide building blocks to create wayland compositors in Rust. While not being a full-blown compositor, it'll provide objects and interfaces implementing common functionnalities that pretty much any compositor will need, in a generic fashion.

Also:

  • 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 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 Smithay won't stop you if you really want to dive into it).

Current status

Nothing is done yet, I'm starting to figure out the design.

Why?

I'm doing this because I find it interesting. Also, I'd love to see a pure-rust¹ wayland compositor.

(¹: Almost, as some very low-level bits will necessarily still be C. But let's keep them minimal, shall we?)