Hypr/README.md

![Hypr](https://i.imgur.com/LtC153m.png)

![BuildStatus](https://github.com/vaxerski/Hypr/actions/workflows/c-cpp.yml/badge.svg)
![Issues](https://img.shields.io/github/issues/vaxerski/Hypr)
![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/>
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!
<br/>

# Features
- True parabolic animations
- Config reloaded instantly upon saving
- A built-in status bar
- Keybinds
- Tiling windows
- Floating windows
- Workspaces
- Moving / Fullscreening windows

## Roadmap v2 (not in order)
- [x] Upgrade the status bar rendering to Cairo
- [x] Better status bar configability ~ WIP
- [ ] Rounded corners
- [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.)

<br/>

# 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

# Building
See the [Wiki](https://github.com/vaxerski/Hypr/wiki/Building) to see build instructions.

# 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.
Updated README with bling and a new roadmap 2021-11-24 19:59:16 +01:00			`![Hypr](https://i.imgur.com/LtC153m.png)`
Update README.md 2021-11-23 13:39:43 +01:00
Update README.md 2021-11-26 22:02:20 +01:00			`![BuildStatus](https://github.com/vaxerski/Hypr/actions/workflows/c-cpp.yml/badge.svg)`
Update README.md 2021-11-26 22:02:08 +01:00			`![Issues](https://img.shields.io/github/issues/vaxerski/Hypr)`
updated readme shields 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/>`
make the readme not as shit 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.`

Updated README with bling and a new roadmap 2021-11-24 19:59:16 +01:00			`!WARNING: Hypr is still in early development. Please report all bugs in Github issues, or open a PR!`
update readme with news 2021-11-21 21:19:54 +01:00			`<br/>`
make the readme not as shit 2021-11-19 20:46:00 +01:00
			`# Features`
Last point off the roadmap! Wait for a new one! 🎉 🎉🎉🎉 2021-11-23 18:48:03 +01:00			`- True parabolic animations`
Updated README with bling and a new roadmap 2021-11-24 19:59:16 +01:00			`- Config reloaded instantly upon saving`
Last point off the roadmap! Wait for a new one! 🎉 🎉🎉🎉 2021-11-23 18:48:03 +01:00			`- A built-in status bar`
make the readme not as shit 2021-11-19 20:46:00 +01:00			`- Keybinds`
			`- Tiling windows`
Last point off the roadmap! Wait for a new one! 🎉 🎉🎉🎉 2021-11-23 18:48:03 +01:00			`- Floating windows`
update the readme features 2021-11-21 14:34:26 +01:00			`- Workspaces`
			`- Moving / Fullscreening windows`
make the readme not as shit 2021-11-19 20:46:00 +01:00
Updated README with bling and a new roadmap 2021-11-24 19:59:16 +01:00			`## Roadmap v2 (not in order)`
Feat: made the status bar into a separate process. 2021-11-27 13:28:30 +01:00			`- [x] Upgrade the status bar rendering to Cairo`
Bar modules upgrade 2021-11-27 19:07:33 +01:00			`- [x] Better status bar configability ~ WIP`
Updated README with bling and a new roadmap 2021-11-24 19:59:16 +01:00			`- [ ] Rounded corners`
Root window now has a cursor 2021-11-25 17:57:50 +01:00			`- [x] Replace default X11 cursor with the pointer`
Fixed some ghost window cases. (readme update too) 2021-11-24 21:50:44 +01:00			`- [x] Fix ghost windows once and for all`
			`- [ ] Fix windows minimizing themselves to tray not being able to come back without pkill`
Added move to workspace and fixed floating windows being wonky a bit 2021-11-25 17:44:46 +01:00			`- [x] Moving windows between workspaces without floating`
Fixed some ghost window cases. (readme update too) 2021-11-24 21:50:44 +01:00			`- [x] EWMH ~ Basic, idk if i'll add more.`
Updated README with bling and a new roadmap 2021-11-24 19:59:16 +01:00			`- [ ] Docks / Fullscreen Apps etc. auto-detection`
			`- [ ] Fix animation flicker (if possible)`
			`- [ ] Config expansion (rules, default workspaces, etc.)`
Last point off the roadmap! Wait for a new one! 🎉 🎉🎉🎉 2021-11-23 18:48:03 +01:00
update readme with news 2021-11-21 21:19:54 +01:00			`<br/>`
make the readme not as shit 2021-11-19 20:46:00 +01:00
updated readme with config instructions 2021-11-27 19:27:40 +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`

Updated readme with building and contrib instructions 2021-11-26 21:00:13 +01:00			`# Building`
			`See the [Wiki](https://github.com/vaxerski/Hypr/wiki/Building) to see build instructions.`

make the readme not as shit 2021-11-19 20:46:00 +01:00			`# Contributions`
Updated readme with building and contrib instructions 2021-11-26 21:00:13 +01:00			`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.`