Hyprland/README.md

165 lines
4.0 KiB
Markdown
Raw Normal View History

2022-04-18 21:00:16 +00:00
<div align = center>
2022-04-18 20:08:57 +00:00
![Banner]
2022-04-18 21:00:16 +00:00
<br>
2022-04-19 11:38:08 +00:00
![Badge Workflow]
[![Badge License]][License]
![Badge Lines]
![Badge Language]
[![Badge Pull Requests]][Pull Requests]
[![Badge Issues]][Issues]
![Badge Hi Mom]<br>
2022-04-19 09:17:45 +00:00
[![Badge Discord]][Discord]
2022-04-19 11:38:08 +00:00
2022-04-18 21:00:16 +00:00
<br>
2022-04-19 09:17:45 +00:00
Hyprland is a dynamic tiling Wayland compositor based on wlroots that doesn't sacrifice on its looks.
2022-04-18 20:08:57 +00:00
2022-04-19 09:17:45 +00:00
For Hyprland without the `land` part, see [Hypr], the Xorg window manager.
2022-04-19 11:38:08 +00:00
2022-04-18 21:00:16 +00:00
<br>
<br>
2022-04-18 20:08:57 +00:00
2022-04-18 21:02:59 +00:00
---
2022-04-18 21:34:52 +00:00
**[<kbd><br>Install<br></kbd>][Install]**
2022-04-21 16:43:58 +00:00
**[<kbd><br>Quick Start<br></kbd>][Quick Start]**
2022-04-18 21:06:58 +00:00
**[<kbd><br>Configure<br></kbd>][Configure]**
**[<kbd><br>Contribute<br></kbd>][Contribute]**
2022-03-16 19:50:55 +00:00
2022-04-18 21:21:58 +00:00
---
2022-04-18 21:42:57 +00:00
<br>
2022-04-18 21:42:04 +00:00
2022-04-19 09:17:45 +00:00
</div>
# Notice
2022-04-19 11:38:08 +00:00
2022-06-01 20:00:46 +00:00
Hyprland is still in pretty early development compared to some other Wayland compositors.
2022-04-18 21:42:04 +00:00
2022-06-01 20:00:46 +00:00
Although Hyprland is pretty stable, it may have some bugs.
2022-04-29 19:43:04 +00:00
2022-04-18 21:42:04 +00:00
### Help Wanted
2022-04-19 09:17:45 +00:00
Hyprland needs testers! <br/>
Try it out and report bugs / suggestions!
2022-03-20 17:02:20 +00:00
2022-04-18 21:21:58 +00:00
# Features
2022-04-19 11:38:08 +00:00
2022-04-18 21:21:58 +00:00
- Easily expandable and readable codebase
- Config reloaded instantly upon saving
2022-05-12 09:37:14 +00:00
- Custom bezier curve based animations
2022-05-31 12:15:28 +00:00
- wlr_ext workspaces protocol support
2022-04-24 14:44:39 +00:00
- Dual Kawase blur
2022-05-31 12:15:28 +00:00
- Fully dynamic workspaces
2022-06-01 20:00:46 +00:00
- Closely follows wlroots-git
- Bundled wlroots
2022-05-31 12:15:28 +00:00
- Window / layer fade in / out
2022-04-19 09:17:45 +00:00
- Tiling/floating/fullscreen windows
2022-05-31 12:15:28 +00:00
- Special Workspace (Scratchpad)
2022-04-19 09:17:45 +00:00
- Window/monitor rules
- Socket-based IPC
2022-05-31 12:15:28 +00:00
- Event System for bash scripts
2022-04-19 09:17:45 +00:00
- Rounded corners
2022-05-31 12:15:28 +00:00
- Full Damage tracking
2022-04-19 09:17:45 +00:00
- Docks support
2022-03-20 17:02:20 +00:00
2022-04-18 21:36:58 +00:00
<br>
<br>
2022-04-02 19:16:53 +00:00
2022-04-18 20:24:23 +00:00
<div align = center>
2022-04-18 21:36:58 +00:00
# Gallery
2022-04-18 21:30:24 +00:00
2022-04-18 21:32:51 +00:00
<br>
2022-04-18 20:08:57 +00:00
![Preview A]
2022-03-20 17:02:20 +00:00
2022-04-18 20:24:23 +00:00
<br>
2022-04-18 21:32:51 +00:00
![Preview B]
2022-04-18 20:24:23 +00:00
2022-05-15 16:31:30 +00:00
<br>
![Preview C]
2022-04-18 21:32:51 +00:00
<br>
2022-04-18 20:24:23 +00:00
<br>
2022-04-18 21:36:58 +00:00
# Stars Over Time
2022-04-18 20:24:23 +00:00
<br>
2022-04-18 21:32:51 +00:00
[![Stars Preview]][Stars]
2022-04-18 20:24:23 +00:00
2022-04-18 21:32:51 +00:00
<br>
2022-04-18 20:24:23 +00:00
<br>
</div>
2022-04-18 21:36:58 +00:00
# Special Thanks
2022-04-18 21:30:24 +00:00
<br>
2022-04-19 09:17:45 +00:00
**[wlroots]** - *For their amazing library*
2022-03-27 10:11:01 +00:00
2022-04-19 09:17:45 +00:00
**[tinywl]** - *For showing how 2 do stuff*
2022-03-27 10:11:01 +00:00
2022-04-19 09:17:45 +00:00
**[Sway]** - *For showing how 2 do stuff the overkill way*
2022-04-18 21:30:24 +00:00
2022-04-19 09:17:45 +00:00
**[Vivarium]** - *For showing how 2 do stuff the simple way*
2022-04-18 21:30:24 +00:00
2022-04-19 09:17:45 +00:00
**[dwl]** - *For showing how 2 do stuff the hacky way*
2022-04-18 21:30:24 +00:00
2022-04-19 09:17:45 +00:00
**[Wayfire]** - *For showing how 2 do some graphics stuff*
2022-04-18 20:08:57 +00:00
<!----------------------------------------------------------------------------->
[Configure]: https://github.com/vaxerski/Hyprland/wiki/Configuring-Hyprland
[Discord]: https://discord.gg/hQ9XvMUjjr
[Stars]: https://starchart.cc/vaxerski/Hyprland
[Hypr]: https://github.com/vaxerski/Hypr
2022-04-18 21:08:55 +00:00
[Pull Requests]: https://github.com/vaxerski/Hyprland/pulls
[Issues]: https://github.com/vaxerski/Hyprland/issues
2022-04-18 21:36:58 +00:00
[Todo]: https://github.com/vaxerski/Hyprland/projects?type=beta
2022-04-18 21:08:55 +00:00
2022-04-18 21:34:18 +00:00
[Contribute]: docs/Contribute.md
2022-04-21 16:43:58 +00:00
[Install]: https://github.com/vaxerski/Hyprland/wiki/Installation
[Quick Start]: https://github.com/vaxerski/Hyprland/wiki/Quick-start
2022-04-18 21:08:55 +00:00
[License]: LICENSE
2022-04-18 20:08:57 +00:00
2022-04-18 21:30:24 +00:00
<!----------------------------------{ Thanks }--------------------------------->
[Vivarium]: https://github.com/inclement/vivarium
[WlRoots]: https://gitlab.freedesktop.org/wlroots/wlroots
[Wayfire]: https://github.com/WayfireWM/wayfire
[TinyWl]: https://gitlab.freedesktop.org/wlroots/wlroots/-/blob/master/tinywl/tinywl.c
[Sway]: https://github.com/swaywm/sway
[DWL]: https://github.com/djpohly/dwl
2022-04-18 20:08:57 +00:00
<!----------------------------------{ Images }--------------------------------->
[Stars Preview]: https://starchart.cc/vaxerski/Hyprland.svg
2022-05-15 16:31:30 +00:00
[Preview A]: https://i.imgur.com/NbrTnZH.png
[Preview B]: https://i.imgur.com/ZA4Fa8R.png
[Preview C]: https://i.imgur.com/BpXxM8H.png
2022-04-18 20:08:57 +00:00
[Banner]: https://raw.githubusercontent.com/vaxerski/Hyprland/main/assets/hyprland.png
<!----------------------------------{ Badges }--------------------------------->
[Badge Workflow]: https://github.com/vaxerski/Hyprland/actions/workflows/ci.yaml/badge.svg
2022-04-18 21:00:16 +00:00
2022-04-19 09:17:45 +00:00
[Badge Discord]: https://img.shields.io/badge/Join%20the-Discord%20server-6666ff
[Badge Issues]: https://img.shields.io/github/issues/vaxerski/Hyprland
[Badge Pull Requests]: https://img.shields.io/github/issues-pr/vaxerski/Hyprland
[Badge Language]: https://img.shields.io/github/languages/top/vaxerski/Hyprland
[Badge License]: https://img.shields.io/github/license/vaxerski/Hyprland
[Badge Lines]: https://img.shields.io/tokei/lines/github/vaxerski/Hyprland
[Badge Hi Mom]: https://img.shields.io/badge/Hi-mom!-ff69b4