From 9da94f260150e2feb5e897548c707297e72ff8f6 Mon Sep 17 00:00:00 2001
From: vaxerski <43317083+vaxerski@users.noreply.github.com>
Date: Wed, 24 Nov 2021 19:59:16 +0100
Subject: [PATCH] Updated README with bling and a new roadmap
---
README.md | 36 ++++++++++++++----------------------
1 file changed, 14 insertions(+), 22 deletions(-)
diff --git a/README.md b/README.md
index 0786f2f..361ae4b 100644
--- a/README.md
+++ b/README.md
@@ -1,40 +1,32 @@
-# Hypr
-
-! WARNING: Hypr is still in early development, expect bugs! Make sure to open an issue if you encounter one though! =)
+
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.
-(Readme is more-or-less wip, I know it's ugly.)
+!WARNING: Hypr is still in early development. Please report all bugs in Github issues, or open a PR!
# Features
- True parabolic animations
+- Config reloaded instantly upon saving
- A built-in status bar
- Keybinds
- Tiling windows
- Floating windows
- Workspaces
-- Config reloaded instantly upon saving
- Moving / Fullscreening windows
-## Roadmap (not in order)
-- [x] Multi-monitor support
-- [x] Status bar ~ Needs expanding
-- [x] Floating windows support
-- [x] Config system
-- [x] Workspaces
-- [x] Moving windows / user input (e.g. fullscreening) ~ More to be done probably
-- [x] True lerp animations ~ BETA
-- [x] Rewriting the window system to be a tree
-
-Roadmap complete! Wait for a redone readme and a new one! 🎉
+## Roadmap v2 (not in order)
+- [ ] Upgrade the status bar rendering to Cairo
+- [ ] Better status bar configability
+- [ ] Rounded corners
+- [ ] Fix ghost windows once and for all
+- [ ] Moving windows between workspaces without floating
+- [ ] EWMH
+- [ ] Docks / Fullscreen Apps etc. auto-detection
+- [ ] Fix animation flicker (if possible)
+- [ ] Config expansion (rules, default workspaces, etc.)
# Contributions
-Welcome. I actually read PRs.
-
-
-
-I will make this readme better in the future cant be arsed to do it rn
-
also graphics wip
+Welcome. I actually read PRs. Please see CONTRIBUTING.md