Go to file

Victor Berger b6a2fe7748 travis: add a redirect doc homepage		2017-10-01 20:34:24 +02:00
examples	cargo fmt	2017-09-30 12:05:28 +02:00
src	cargo fmt	2017-09-30 12:05:28 +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: test various features combination	2017-09-30 12:05:28 +02:00
CONTRIBUTING.md	Create CONTRIBUTING.md	2017-04-21 12:01:26 +02:00
Cargo.toml	travis: test various features combination	2017-09-30 12:05:28 +02:00
LICENSE.txt	Add MIT license	2017-03-24 10:24:07 +01:00
README.md	Add Gitter badge	2017-02-22 22:11:14 +00: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
doc_upload.sh	travis: add a redirect doc homepage	2017-10-01 20:34:24 +02:00

README.md

Smithay

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?)