Hyprland/README.md
2022-05-15 18:31:30 +02:00

162 lines
3.9 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div align = center>
![Banner]
<br>
![Badge Workflow]
[![Badge License]][License]
![Badge Lines]
![Badge Language]
[![Badge Pull Requests]][Pull Requests]
[![Badge Issues]][Issues]
![Badge Hi Mom]<br>
[![Badge Discord]][Discord]
<br>
Hyprland is a dynamic tiling Wayland compositor based on wlroots that doesn't sacrifice on its looks.
For Hyprland without the `land` part, see [Hypr], the Xorg window manager.
<br>
<br>
---
**[<kbd><br>Install<br></kbd>][Install]**
**[<kbd><br>Quick Start<br></kbd>][Quick Start]**
**[<kbd><br>Configure<br></kbd>][Configure]**
**[<kbd><br>Contribute<br></kbd>][Contribute]**
---
<br>
</div>
# Notice
This project is still in its early development, expect bugs.
Once you get it working though, it's pretty stable.<br/>
### Help Wanted
Hyprland needs testers! <br/>
Try it out and report bugs / suggestions!
# Features
- Easily expandable and readable codebase
- Config reloaded instantly upon saving
- Bezier-curve window animations
- Custom bezier curve based animations
- Workspaces protocol support
- Dual Kawase blur
- Window fade in / out
- Tiling/floating/fullscreen windows
- Window/monitor rules
- Socket-based IPC
- Rounded corners
- Damage tracking(*Experimental*)
- Moving/resizing
- Docks support
<br>
<br>
<div align = center>
# Gallery
<br>
![Preview A]
<br>
![Preview B]
<br>
![Preview C]
<br>
<br>
# Stars Over Time
<br>
[![Stars Preview]][Stars]
<br>
<br>
</div>
# Special Thanks
<br>
**[wlroots]** - *For their amazing library*
**[tinywl]** - *For showing how 2 do stuff*
**[Sway]** - *For showing how 2 do stuff the overkill way*
**[Vivarium]** - *For showing how 2 do stuff the simple way*
**[dwl]** - *For showing how 2 do stuff the hacky way*
**[Wayfire]** - *For showing how 2 do some graphics stuff*
<!----------------------------------------------------------------------------->
[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
[Pull Requests]: https://github.com/vaxerski/Hyprland/pulls
[Issues]: https://github.com/vaxerski/Hyprland/issues
[Todo]: https://github.com/vaxerski/Hyprland/projects?type=beta
[Contribute]: docs/Contribute.md
[Install]: https://github.com/vaxerski/Hyprland/wiki/Installation
[Quick Start]: https://github.com/vaxerski/Hyprland/wiki/Quick-start
[License]: LICENSE
<!----------------------------------{ 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
<!----------------------------------{ Images }--------------------------------->
[Stars Preview]: https://starchart.cc/vaxerski/Hyprland.svg
[Preview A]: https://i.imgur.com/NbrTnZH.png
[Preview B]: https://i.imgur.com/ZA4Fa8R.png
[Preview C]: https://i.imgur.com/BpXxM8H.png
[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
[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