Hyprland/README.md

<div align = center>

![Banner]

<br>

[![Badge License]][License]![Badge Lines]![Badge Language] <br>
[![Badge Pull Requests]][Pull Requests][![Badge Issues]][Issues]

<br>

***A Dynamic Wayland Tiling Compositor***

<br>
<br>

[![Badge Discord]][Discord]
 
<br>


---

**[<kbd> <br> Install <br> </kbd>][Install]** 
**[<kbd> <br> Configure <br> </kbd>][Configure]** 
**[<kbd> <br> Todo <br> </kbd>][Todo]** 
**[<kbd> <br> Contribute <br> </kbd>][Contribute]**

---

<br>
 
### Related

*For **Hyprland** without the* `land` *part,* <br>
*see **[Hypr]**, the **Xorg Window Manager**.*

<br>

### Notice

*This project is still in it's early stages* <br>
***Expect Some Bugs***

![Badge Workflow]

*However once you get it working, it's pretty stable*

<br>

### Help Wanted

**We needs testers!** <br>
*Try it out and report bugs or suggestions!*

</div>

# Features
- Easily expandable and readable codebase
- Config reloaded instantly upon saving
- Parabolic Window Animations
- Workspaces Protocol Support
- Tiling / Floating / Fullscreen
- Window / Monitor Rules
- Socket - Based IPC
- Rounded Corners
- Damage Tracking ( *Experimental* )
- Moving / Resizing
- Docks Support
- Fade In / Out
- Window Blur


<br>
<br>

<div align = center>

# Gallery

<br>

![Preview A]

<br>

![Preview B]

<br>
<br>

# Stars Over Time

<br>

[![Stars Preview]][Stars]

<br>
<br>

</div>

# Special Thanks

<br>

**[WlRoots]**

  *Their amazing library*

**[TinyWl]**

  *Showing how 2 do stuff*

**[Sway]**

  *Showing how 2 do stuff the **overkill** way*

**[Vivarium]**

  *Showing how 2 do stuff the **simple** way*

**[DWL]**

  *Showing how 2 do stuff the **hacky** way*

**[Wayfire]**

  *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]: docs/Install.md
[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/ZA4Fa8R.png
[Preview B]: 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/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white
[Badge Issues]: https://img.shields.io/github/issues/vaxerski/Hyprland?style=for-the-badge&label=%ef%bc%a9%ef%bd%93%ef%bd%93%ef%bd%95%ef%bd%85%ef%bd%93
[Badge Pull Requests]: https://img.shields.io/github/issues-pr/vaxerski/Hyprland?style=for-the-badge&label=%ef%bc%b0%ef%bd%95%ef%bd%8c%ef%bd%8c%20%ef%bc%b2%ef%bd%85%ef%bd%91%ef%bd%95%ef%bd%85%ef%bd%93%ef%bd%94%ef%bd%93
[Badge Language]: https://img.shields.io/github/languages/top/vaxerski/Hyprland?style=for-the-badge&label=%ef%bc%a3%ef%bc%8b%ef%bc%8b
[Badge License]: https://img.shields.io/badge/License-BSD_3--Clause-blue.svg?style=for-the-badge&label=%ef%bc%ac%ef%bd%89%ef%bd%83%ef%bd%85%ef%bd%8e%ef%bd%93%ef%bd%85
[Badge Lines]: https://img.shields.io/tokei/lines/github/vaxerski/Hyprland?style=for-the-badge&label=%ef%bc%a3%ef%bd%8f%ef%bd%84%ef%bd%85