Hyprland/README.md

74 lines
2.2 KiB
Markdown
Raw Normal View History

2022-04-01 22:19:33 +03:00
<p align="center">
<img src="https://raw.githubusercontent.com/vaxerski/Hyprland/main/assets/hyprland.png" />
<br/><br/>
<img src="https://github.com/vaxerski/Hyprland/actions/workflows/ci.yaml/badge.svg" />
<img src="https://img.shields.io/github/issues/vaxerski/Hyprland" />
<img src="https://img.shields.io/github/issues-pr/vaxerski/Hyprland" />
<img src="https://img.shields.io/github/languages/top/vaxerski/Hyprland" />
2022-04-01 22:20:03 +03:00
<img src="https://img.shields.io/github/license/vaxerski/Hyprland" />
2022-04-01 22:19:33 +03:00
<img src="https://img.shields.io/tokei/lines/github/vaxerski/Hyprland" />
<img src="https://img.shields.io/badge/Hi-mom!-ff69b4" />
</p>
2022-03-20 20:02:20 +03:00
<br/><br/>
Hyprland is a Dynamic Tiling Wayland Compositor in early development stages.
2022-03-16 22:50:55 +03:00
For Hyprland without the land part, see [Hypr](https://github.com/vaxerski/Hypr), the Xorg window manager.
2022-03-20 20:02:20 +03:00
WARNING!
2022-03-30 23:31:04 +03:00
Hyprland is in early dev, expect bugs, instabilities and crashes. You have been warned!
2022-03-20 20:02:20 +03:00
Nevertheless, REPORT any you find! Make an issue!
# Key features
2022-03-24 00:01:59 +03:00
- Basic window animations
2022-03-20 20:02:20 +03:00
- Config reloaded instantly upon saving
- Easily expandable and readable codebase
- Support for docks/whatever
2022-03-24 20:22:01 +03:00
- Window rules
2022-03-20 20:02:20 +03:00
- Monitor rules
2022-03-21 21:18:33 +03:00
- Socket-based IPC
- Tiling/floating/fullscreen windows
2022-03-20 20:02:20 +03:00
- Moving/resizing windows
# Major to-dos
- Switch to fully custom OpenGL rendering
2022-03-30 23:31:04 +03:00
- Damage tracking
2022-03-24 00:01:59 +03:00
- Animations (better)
2022-03-20 20:02:20 +03:00
- Rounded corners
- Blur
2022-03-20 22:26:06 +03:00
- Fadein/out
- Fix electron rendering issues
- Optimization
- Fix weird scroll on XWayland
- Become sane
2022-03-20 20:02:20 +03:00
- STABILITY
2022-03-20 22:26:06 +03:00
- More config options for tweakers
- Improve hyprctl
2022-03-20 20:02:20 +03:00
# Installation
Please refer to the [Wiki Page](https://github.com/vaxerski/Hyprland/wiki/Installation)
<br/>
# Configuring
Head onto the [Wiki Page](https://github.com/vaxerski/Hyprland/wiki/Configuring-Hyprland) to see more.
Hyprland without a config is a bad idea!
<br/>
# Gallery
![Image1](https://i.imgur.com/SIPepse.png)
<br/>
# Contributions
Welcome, I'll make a CONTRIBUTING.md some time in the future.
2022-03-27 13:10:47 +03:00
# Special thanks
tinywl - for showing how 2 do stuff
2022-03-27 13:11:01 +03:00
2022-03-27 13:10:47 +03:00
sway - for showing how 2 do stuff the overkill way
2022-03-27 13:11:01 +03:00
2022-03-27 13:10:47 +03:00
vivarium - for showing how 2 do stuff the simple way
2022-03-27 13:11:01 +03:00
2022-03-27 13:10:47 +03:00
dwl - for showing how 2 do stuff the hacky way
2022-03-27 13:11:01 +03:00
2022-03-27 13:10:47 +03:00
wayfire - for showing how 2 do custom rendering