diff --git a/README.md b/README.md index e2688ef..014cc9f 100644 --- a/README.md +++ b/README.md @@ -15,29 +15,16 @@ Hypr is a Linux tiling window manager for Xorg. It's written in XCB with modern # Key Features - True parabolic animations +- Rounded corners and borders - Config reloaded instantly upon saving - A built-in status bar with modules -- Rounded corners (simple) +- Easily expandable and readable codebase - Keybinds config - 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 -- [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 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 ![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) # Building 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 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.