zwin

zwin copied to clipboard

= Zwin

image::https://github.com/zwin-project/zwin/actions/workflows/test.yaml/badge.svg[link="https://github.com/zwin-project/zwin/actions/workflows/test.yaml"]

image:./docs/images/logo_with_sm_padding.svg[width=200px]

Zwin is a project to define a protocol for the 3D Windowing System on top of https://wayland.freedesktop.org/[Wayland].

This zwin library provides a communication protocol and library implementation of the protocol.

== Try it out

If you want to try out Zwin, you should probably install Zen (our reference compositor). See https://www.zwin.dev/getting_started/system_requirements[our installation guide].

== Build & Install This section is for Zwin app developers: regular users should see the above guides.

[source, shell]

$ git clone https://github.com/zwin-project/zwin.git $ cd zwin $ meson build $ ninja -C build install

== Contributing

See link:./docs/CONTRIBUTING.adoc[contribution doc].