Go to file
Lu YaNing 0c0ba4d817 chore(debian): update version to 0.5.21.1
Log: update version
2025-07-25 09:30:07 +08:00
.github chore: remove dependabot and only use renovate 2025-02-26 10:20:29 +08:00
LICENSES chore: add missing license 2025-02-10 05:16:07 +00:00
cmake refactor: split directory 2024-12-14 14:25:48 +08:00
debian chore(debian): update version to 0.5.21.1 2025-07-25 09:30:07 +08:00
examples chore: clear up cmake 2025-02-10 13:17:32 +08:00
misc fix: can't start on VirtualBox 2025-02-12 09:33:47 +08:00
nix chore: update nix package 2025-02-11 17:53:49 +08:00
src feat: Add multi-seat support 2025-07-24 21:19:31 +08:00
tests feat: use wwrappointer from waylib 2024-12-19 16:34:38 +08:00
translations chore: update ts 2024-11-21 14:23:54 +08:00
waylib@130abe211c chore(deps): update waylib digest to 130abe2 2025-02-20 19:27:28 +08:00
.clang-format Revert too new clang-format standard. 2024-11-15 14:37:55 +08:00
.editorconfig feat: add `.editorconfig` 2024-03-07 11:26:41 +08:00
.envrc chore: fix not found qtsvg in nixos 2024-01-24 21:47:19 +08:00
.gitignore chore: code review for dconfig and debian files 2024-09-09 10:20:21 +08:00
.gitmodules fork from sddm 2023-09-04 17:27:44 +08:00
CMakeLists.txt chore: clear up cmake 2025-02-10 13:17:32 +08:00
CMakePresets.json feat: add clang for cmake presets 2024-09-20 16:38:58 +08:00
README.md feat: add readme for treeland 2024-12-11 11:09:32 +08:00
README.zh_CN.md feat: add readme for treeland 2024-12-11 11:09:32 +08:00
REUSE.toml chore: upgrade licenses 2024-09-18 18:32:26 +08:00
flake.lock chore(deps): lock file maintenance 2025-02-20 19:27:46 +08:00
flake.nix chore: update nix package 2025-02-11 17:53:49 +08:00
garnix.yaml feat: allow ddm works in nixos 2024-03-06 13:21:37 +08:00
renovate.json feat: automate nix updates with renovate 2023-12-12 15:16:16 +08:00

README.md

Treeland

treeland is a wayland compositor based on wlroots and QtQuick, designed to provide efficient and flexible graphical interface support.

Dependencies

Check the debian/control file to understand specific build and runtime dependencies, or use cmake to check for missing necessary components.

Core build dependencies:

  • waylib: A Wayland compositor development library based on wlroots and QtQuick
    • Qt >= 6.8.0
    • wlroots = 0.18
  • treeland-protocols: Private Wayland protocols used by treeland

Recommended runtime dependencies:

  • ddm: A display manager optimized for multiple users

Building

Treeland uses cmake for building. The WITH_SUBMODULE_WAYLIB option can force the use of the waylib code from the submodule. If you want to use the system-provided waylib, set this option to OFF.

Using the system-provided waylib:

$ git clone git@github.com:linuxdeepin/treeland.git
$ cd treeland
$ cmake -Bbuild -DWITH_SUBMODULE_WAYLIB=OFF
$ cmake --build build

Using the waylib from the submodule:

$ git clone git@github.com:linuxdeepin/treeland.git --recursive
$ cd treeland
$ cmake -Bbuild -DWITH_SUBMODULE_WAYLIB=ON
$ cmake --build build

Packaging

A debian folder is provided to build the package under the deepin linux desktop distribution. To build the package, use the following command:

$ sudo apt build-dep . # install build dependencies
$ dpkg-buildpackage -uc -us -nc -b # build binary package(s)

Getting Involved

License

treeland is licensed under Apache-2.0 OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only.