Hypr/README.md

50 lines
2 KiB
Markdown
Raw Normal View History

![Hypr](https://i.imgur.com/LtC153m.png)
2021-11-23 13:39:43 +01:00
2021-11-26 22:02:20 +01:00
![BuildStatus](https://github.com/vaxerski/Hypr/actions/workflows/c-cpp.yml/badge.svg)
2021-11-26 22:02:08 +01:00
![Issues](https://img.shields.io/github/issues/vaxerski/Hypr)
2021-11-24 20:13:40 +01:00
![PRs](https://img.shields.io/github/issues-pr/vaxerski/Hypr)
![Lang](https://img.shields.io/github/languages/top/vaxerski/Hypr)
![License](https://img.shields.io/github/license/vaxerski/Hypr)
![Best](https://img.shields.io/badge/Standard-C%2B%2B20-success)
![HiMom](https://img.shields.io/badge/Hi-mom!-ff69b4)
<br/><br/>
2021-11-19 20:46:00 +01:00
Hypr is a Linux tiling window manager for Xorg. It's written in XCB with modern C++ and aims to provide easily readable and expandable code.
!WARNING: Hypr is still in early development. Please report all bugs in Github issues, or open a PR!
2021-11-21 21:19:54 +01:00
<br/>
2021-11-19 20:46:00 +01:00
2021-11-28 14:14:12 +01:00
# Key Features
- True parabolic animations
2021-12-04 16:01:29 +01:00
- Rounded corners and borders
- Config reloaded instantly upon saving
2021-11-28 14:14:12 +01:00
- A built-in status bar with modules
2021-12-04 16:01:29 +01:00
- Easily expandable and readable codebase
2021-12-04 23:17:56 +01:00
- Multiple tiling modes (dwindling and master)
2021-11-28 14:14:12 +01:00
- Keybinds config
2021-11-19 20:46:00 +01:00
- Tiling windows
- Floating windows
2021-11-21 14:34:26 +01:00
- Workspaces
- Moving / Fullscreening windows
2021-11-19 20:46:00 +01:00
# Configuring
See the [Wiki Page](https://github.com/vaxerski/Hypr/wiki/Configuring-Hypr) for a detailed overview on the config, or refer to the example config in examples/hypr.conf.
To use a custom config, place it in ~/.config/hypr/hypr.conf
2021-11-27 19:41:16 +01:00
# Screenshot Gallery
2021-11-30 22:05:22 +01:00
![One](https://i.imgur.com/WJhbvij.png)
2021-12-04 16:01:29 +01:00
![Two](https://i.imgur.com/B0MDTu2.png)
2021-11-27 19:41:16 +01:00
![Three](https://i.imgur.com/yvZVde7.png)
# Building
See the [Wiki](https://github.com/vaxerski/Hypr/wiki/Building) to see build instructions.
2021-12-04 16:01:29 +01:00
# Known issues
- Animations do tend to flicker a bit, especially with picom.
- The config is still pretty simple, although riceable!
- Popups sometimes are created pretty small
2021-11-19 20:46:00 +01:00
# Contributions
Refer to [CONTRIBUTING.md](https://github.com/vaxerski/Hypr/blob/main/CONTRIBUTING.md) and the [Wiki](https://github.com/vaxerski/Hypr/wiki/Contributing-&-Debugging) for contributing instructions and guidelines.