hyprwm/Hypr
1
0
Fork 0
mirror of https://github.com/hyprwm/Hypr.git synced 2024-11-25 22:35:58 +01:00
Code Issues Projects Releases Packages Wiki Activity

updated the readme, roadmap 2 done

Browse source
This commit is contained in:
vaxerski 2021-12-04 16:01:29 +01:00 committed by GitHub
parent db258c63bb
commit 61cd52f669
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -15,29 +15,16 @@ Hypr is a Linux tiling window manager for Xorg. It's written in XCB with modern
# Key Features # Key Features
- True parabolic animations - True parabolic animations
- Rounded corners and borders
- Config reloaded instantly upon saving - Config reloaded instantly upon saving
- A built-in status bar with modules - A built-in status bar with modules
- Rounded corners (simple) - Easily expandable and readable codebase
- Keybinds config - Keybinds config
- Tiling windows - Tiling windows
- Floating windows - Floating windows
- Workspaces - Workspaces
- Moving / Fullscreening windows - Moving / Fullscreening windows
## Roadmap v2 (not in order)
- [x] Upgrade the status bar rendering to Cairo
- [x] Better status bar configability ~ WIP
- [x] Rounded corners ~ meh
- [x] Replace default X11 cursor with the pointer
- [x] Fix ghost windows once and for all
- [x] 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.
- [x] Docks / Fullscreen Apps etc. auto-detection
- [ ] Fix animation flicker (if possible)
- [ ] Config expansion (rules, default workspaces, etc.)
# Configuring # 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. 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.
@ -46,11 +33,16 @@ To use a custom config, place it in ~/.config/hypr/hypr.conf
# Screenshot Gallery # Screenshot Gallery
![One](https://i.imgur.com/WJhbvij.png) ![One](https://i.imgur.com/WJhbvij.png)
![Two](https://i.imgur.com/Qpq1Jfk.png) ![Two](https://i.imgur.com/B0MDTu2.png)
![Three](https://i.imgur.com/yvZVde7.png) ![Three](https://i.imgur.com/yvZVde7.png)
# Building # Building
See the [Wiki](https://github.com/vaxerski/Hypr/wiki/Building) to see build instructions. See the [Wiki](https://github.com/vaxerski/Hypr/wiki/Building) to see build instructions.
# 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
# Contributions # 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. 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.