Hyprland/README.md

175 lines
4.1 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-18 21:08:55 +00:00
[![Badge License]][License]![Badge Lines]![Badge Language] <br>
[![Badge Pull Requests]][Pull Requests][![Badge Issues]][Issues]
2022-04-18 21:00:16 +00:00
<br>
2022-04-18 21:03:53 +00:00
***A Dynamic Wayland Tiling Compositor***
2022-04-18 20:08:57 +00:00
2022-04-18 21:00:16 +00:00
<br>
<br>
2022-04-18 20:08:57 +00:00
2022-04-18 21:03:53 +00:00
[![Badge Discord]][Discord]
2022-04-18 21:00:16 +00:00
<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-18 21:06:58 +00:00
**[<kbd><br>Configure<br></kbd>][Configure]**
2022-04-18 21:36:58 +00:00
**[<kbd><br>Todo<br></kbd>][Todo]**
2022-04-18 21:06:58 +00:00
**[<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
### 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***
2022-04-18 21:02:59 +00:00
2022-04-18 21:53:53 +00:00
![Badge Workflow]
2022-04-18 21:42:04 +00:00
*However Once you get it working, it's pretty stable*
2022-04-13 16:44:52 +00:00
2022-04-18 21:42:04 +00:00
<br>
### Help Wanted
**We needs testers!** <br>
*Try it out and report bugs or suggestions!*
</div>
2022-03-20 17:02:20 +00:00
2022-04-18 21:21:58 +00:00
# Features
- Easily expandable and readable codebase
- Config reloaded instantly upon saving
- Parabolic Window Animations
- Workspaces Protocol Support
- Tiling/Floating/Fullscreen
- Window/Monitor Rules
- Moving/Resizing
- Socket-Based IPC
- Rounded Corners
- Damage Tracking(*Experimental*)
- Docks Support
- Fade In/Out
- Window Blur
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-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>
**[WlRoots]**
*Their amazing library*
**[TinyWl]**
*Showing how 2 do stuff*
2022-04-18 21:30:24 +00:00
**[Sway]**
2022-03-27 10:11:01 +00:00
2022-04-18 21:32:51 +00:00
*Showing how 2 do stuff the **overkill** way*
2022-03-27 10:11:01 +00:00
2022-04-18 21:30:24 +00:00
**[Vivarium]**
2022-03-27 10:11:01 +00:00
2022-04-18 21:32:51 +00:00
*Showing how 2 do stuff the **simple** way*
2022-03-27 10:11:01 +00:00
2022-04-18 21:30:24 +00:00
**[DWL]**
2022-04-18 21:32:51 +00:00
*Showing how 2 do stuff the **hacky** way*
2022-04-18 21:30:24 +00:00
**[Wayfire]**
2022-04-18 21:32:51 +00:00
*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
[Install]: docs/Install.md
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
[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
2022-04-18 21:00:16 +00:00
[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