mirror of
https://github.com/hyprwm/wlroots-hyprland.git
synced 2024-12-22 09:59:48 +01:00
README: Update info for fork
This commit is contained in:
parent
b1b34cd665
commit
f4883bc965
1 changed files with 6 additions and 83 deletions
89
README.md
89
README.md
|
@ -1,87 +1,10 @@
|
|||
# wlroots
|
||||
# wlroots-hyprland
|
||||
|
||||
Pluggable, composable, unopinionated modules for building a [Wayland]
|
||||
compositor; or about 60,000 lines of code you were going to write anyway.
|
||||
This is a fork of the Freedesktop wlroots' project.
|
||||
|
||||
- wlroots provides backends that abstract the underlying display and input
|
||||
hardware, including KMS/DRM, libinput, Wayland, X11, and headless backends,
|
||||
plus any custom backends you choose to write, which can all be created or
|
||||
destroyed at runtime and used in concert with each other.
|
||||
- wlroots provides unopinionated, mostly standalone implementations of many
|
||||
Wayland interfaces, both from wayland.xml and various protocol extensions.
|
||||
We also promote the standardization of portable extensions across
|
||||
many compositors.
|
||||
- wlroots provides several powerful, standalone, and optional tools that
|
||||
implement components common to many compositors, such as the arrangement of
|
||||
outputs in physical space.
|
||||
- wlroots provides an Xwayland abstraction that allows you to have excellent
|
||||
Xwayland support without worrying about writing your own X11 window manager
|
||||
on top of writing your compositor.
|
||||
- wlroots provides a renderer abstraction that simple compositors can use to
|
||||
avoid writing GL code directly, but which steps out of the way when your
|
||||
needs demand custom rendering code.
|
||||
Due to some internal strife, and to aid Hyprland development, we maintain a fork with
|
||||
some minor changes.
|
||||
|
||||
wlroots implements a huge variety of Wayland compositor features and implements
|
||||
them *right*, so you can focus on the features that make your compositor
|
||||
unique. By using wlroots, you get high performance, excellent hardware
|
||||
compatibility, broad support for many wayland interfaces, and comfortable
|
||||
development tools - or any subset of these features you like, because all of
|
||||
them work independently of one another and freely compose with anything you want
|
||||
to implement yourself.
|
||||
## Notice
|
||||
|
||||
Check out our [wiki] to get started with wlroots. Join our IRC channel:
|
||||
[#wlroots on Libera Chat].
|
||||
|
||||
A variety of [wrapper libraries] are available for using it with your favorite
|
||||
programming language.
|
||||
|
||||
## Building
|
||||
|
||||
Install dependencies:
|
||||
|
||||
* meson
|
||||
* wayland
|
||||
* wayland-protocols
|
||||
* EGL and GLESv2 (optional, for the GLES2 renderer)
|
||||
* Vulkan loader, headers and glslang (optional, for the Vulkan renderer)
|
||||
* libdrm
|
||||
* GBM (optional, for the GBM allocator)
|
||||
* libinput (optional, for the libinput backend)
|
||||
* xkbcommon
|
||||
* udev (optional, for the session)
|
||||
* pixman
|
||||
* [libseat] (optional, for the session)
|
||||
* [hwdata] (optional, for the DRM backend)
|
||||
* [libdisplay-info] (optional, for the DRM backend)
|
||||
* [libliftoff] (optional, for the DRM backend)
|
||||
|
||||
If you choose to enable X11 support:
|
||||
|
||||
* xwayland (build-time only, optional at runtime)
|
||||
* libxcb
|
||||
* libxcb-render-util
|
||||
* libxcb-wm
|
||||
* libxcb-errors (optional, for improved error reporting)
|
||||
|
||||
Run these commands:
|
||||
|
||||
meson setup build/
|
||||
ninja -C build/
|
||||
|
||||
Install like so:
|
||||
|
||||
sudo ninja -C build/ install
|
||||
|
||||
## Contributing
|
||||
|
||||
See [CONTRIBUTING.md].
|
||||
|
||||
[Wayland]: https://wayland.freedesktop.org/
|
||||
[wiki]: https://gitlab.freedesktop.org/wlroots/wlroots/-/wikis/Getting-started
|
||||
[#wlroots on Libera Chat]: https://web.libera.chat/gamja/?channels=#wlroots
|
||||
[wrapper libraries]: https://gitlab.freedesktop.org/wlroots/wlroots/-/wikis/Projects-which-use-wlroots#wrapper-libraries
|
||||
[libseat]: https://git.sr.ht/~kennylevinsen/seatd
|
||||
[hwdata]: https://github.com/vcrhonek/hwdata
|
||||
[libdisplay-info]: https://gitlab.freedesktop.org/emersion/libdisplay-info
|
||||
[libliftoff]: https://gitlab.freedesktop.org/emersion/libliftoff
|
||||
[CONTRIBUTING.md]: https://gitlab.freedesktop.org/wlroots/wlroots/-/blob/master/CONTRIBUTING.md
|
||||
This project has no releases. Hyprland statically links to the correct rev.
|
Loading…
Reference in a new issue