Hyprland/README.md

57 lines
1.6 KiB
Markdown
Raw Normal View History

2022-03-16 20:50:55 +01:00
# Hyprland
2022-03-20 18:02:20 +01:00
*logo is a to-do :P*<br/>
![Issues](https://img.shields.io/github/issues/vaxerski/Hyprland)
![PRs](https://img.shields.io/github/issues-pr/vaxerski/Hyprland)
![Lang](https://img.shields.io/github/languages/top/vaxerski/Hyprland)
![License](https://img.shields.io/github/license/vaxerski/Hyprland)
![Best](https://img.shields.io/badge/Standard-C%2B%2B20-success)
![HiMom](https://img.shields.io/badge/Hi-mom!-ff69b4)
<br/><br/>
Hyprland is a Dynamic Tiling Wayland Compositor in early development stages.
2022-03-16 20:50:55 +01:00
For Hyprland without the land part, see [Hypr](https://github.com/vaxerski/Hypr), the Xorg window manager.
2022-03-20 18:02:20 +01:00
WARNING!
Hyprland is in very early dev, expect bugs, instabilities and crashes. You have been warned!
Nevertheless, REPORT any you find! Make an issue!
# Key features
- Config reloaded instantly upon saving
- Easily expandable and readable codebase
- Support for docks/whatever
- Monitor rules
- Tiling/floating windows
- Moving/resizing windows
# Major to-dos
- Animations
- Rounded corners
- Blur
2022-03-20 20:26:06 +01:00
- Fadein/out
2022-03-20 18:02:20 +01:00
- Window rules
2022-03-20 20:26:06 +01:00
- Fix electron rendering issues
- Fix sloppy dragging of windows
- Optimization
- Fix weird scroll on XWayland
- Become sane
2022-03-20 18:02:20 +01:00
- STABILITY
2022-03-20 20:26:06 +01:00
- More config options for tweakers
- Improve hyprctl
2022-03-20 18:02:20 +01: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.