Hypr/README.md

46 lines
1.8 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
# Features
- True parabolic animations
- Config reloaded instantly upon saving
- A built-in status bar
2021-11-19 20:46:00 +01:00
- Keybinds
- Tiling windows
- Floating windows
2021-11-21 14:34:26 +01:00
- Workspaces
- Moving / Fullscreening windows
2021-11-19 20:46:00 +01:00
## Roadmap v2 (not in order)
- [x] Upgrade the status bar rendering to Cairo
2021-11-27 19:07:33 +01:00
- [x] Better status bar configability ~ WIP
- [ ] Rounded corners
2021-11-25 17:57:50 +01:00
- [x] Replace default X11 cursor with the pointer
- [x] Fix ghost windows once and for all
- [ ] Fix windows minimizing themselves to tray not being able to come back without pkill
- [x] Moving windows between workspaces without floating
- [x] EWMH ~ Basic, idk if i'll add more.
- [ ] Docks / Fullscreen Apps etc. auto-detection
- [ ] Fix animation flicker (if possible)
- [ ] Config expansion (rules, default workspaces, etc.)
2021-11-21 21:19:54 +01:00
<br/>
2021-11-19 20:46:00 +01:00
# Building
See the [Wiki](https://github.com/vaxerski/Hypr/wiki/Building) to see build instructions.
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.