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.

Hypr needs testers! Check it out and report suggestions or bugs!
<br/>

# Key Features
- True parabolic animations
- Rounded corners and borders
- Config reloaded instantly upon saving
- A built-in status bar with modules
- Easily expandable and readable codebase
- Multiple tiling modes (dwindling and master)
- Window rules
- Intelligent transients
- Support for EWMH-compatible bars (e.g. Polybar)
- Keybinds config
- Tiling windows
- Floating windows
- Workspaces
- Moving / Fullscreening windows
- Mostly EWMH and ICCCM compliant

# 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.

You have to use a config, place it in ~/.config/hypr/hypr.conf

# Screenshot Gallery

![One](https://i.imgur.com/HLukmeA.png)
![Two](https://i.imgur.com/B0MDTu2.png)
![Three](https://i.imgur.com/yvZVde7.png)

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

# Known issues
- Picom's shadow and effects do not update for cheap animations while animating
- Non-cheap animations are choppy (duh!)
- Popups sometimes are created a bit off

# 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.`

update readme 2021-12-19 00:50:49 +01:00			`Hypr needs testers! Check it out and report suggestions or bugs!`
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 the readme 2021-11-28 14:14:12 +01:00			`# Key Features`
Last point off the roadmap! Wait for a new one! 🎉 🎉🎉🎉 2021-11-23 18:48:03 +01:00			`- True parabolic animations`
updated the readme, roadmap 2 done 2021-12-04 16:01:29 +01:00			`- Rounded corners and borders`
Updated README with bling and a new roadmap 2021-11-24 19:59:16 +01:00			`- Config reloaded instantly upon saving`
updated the readme 2021-11-28 14:14:12 +01:00			`- A built-in status bar with modules`
updated the readme, roadmap 2 done 2021-12-04 16:01:29 +01:00			`- Easily expandable and readable codebase`
updated readme with new master 2021-12-04 23:17:56 +01:00			`- Multiple tiling modes (dwindling and master)`
updated the readme 2021-12-21 12:26:34 +01:00			`- Window rules`
			`- Intelligent transients`
			`- Support for EWMH-compatible bars (e.g. Polybar)`
updated the readme 2021-11-28 14:14:12 +01:00			`- Keybinds config`
make the readme not as shit 2021-11-19 20:46:00 +01:00			`- 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`
updated the readme 2021-12-21 12:26:34 +01:00			`- Mostly EWMH and ICCCM compliant`
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.`

updated the readme 2021-12-21 12:26:34 +01:00			`You have to use a config, place it in ~/.config/hypr/hypr.conf`
updated readme with config instructions 2021-11-27 19:27:40 +01:00
Added a screenshot gallery 2021-11-27 19:41:16 +01:00			`# Screenshot Gallery`

update the screenshot gallery 2021-12-21 18:39:25 +01:00			`![One](https://i.imgur.com/HLukmeA.png)`
updated the readme, roadmap 2 done 2021-12-04 16:01:29 +01:00			`![Two](https://i.imgur.com/B0MDTu2.png)`
Added a screenshot gallery 2021-11-27 19:41:16 +01:00			`![Three](https://i.imgur.com/yvZVde7.png)`

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.`

updated the readme, roadmap 2 done 2021-12-04 16:01:29 +01:00			`# Known issues`
updated the readme known issues 2021-12-06 19:51:31 +01:00			`- Picom's shadow and effects do not update for cheap animations while animating`
fixed a stroke 2021-12-26 21:08:28 +01:00			`- Non-cheap animations are choppy (duh!)`
fix for a randr event spam bug 2021-12-25 22:56:02 +01:00			`- Popups sometimes are created a bit off`
updated the readme, roadmap 2 done 2021-12-04 16:01:29 +01:00
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.`