From 998c316de1e4efca2fc1554586563b72ebf4bf43 Mon Sep 17 00:00:00 2001 From: vaxerski <43317083+vaxerski@users.noreply.github.com> Date: Tue, 19 Apr 2022 11:17:45 +0200 Subject: Typos, badges and info rewrites --- README.md | 98 +++++++++++++++++++++++---------------------------------------- 1 file changed, 35 insertions(+), 63 deletions(-) diff --git a/README.md b/README.md index 418a3e16..e1fc796a 100644 --- a/README.md +++ b/README.md @@ -4,71 +4,54 @@
-[![Badge License]][License]![Badge Lines]![Badge Language]
-[![Badge Pull Requests]][Pull Requests][![Badge Issues]][Issues] - +[![Badge License]][License] ![Badge Lines] ![Badge Language] [![Badge Pull Requests]][Pull Requests] [![Badge Issues]][Issues] ![Badge Hi Mom]
+[![Badge Discord]][Discord]
-***A Dynamic Wayland Tiling Compositor*** +Hyprland is a dynamic tiling Wayland compositor based on wlroots that doesn't sacrifice on its looks. +For Hyprland without the `land` part, see [Hypr], the Xorg window manager.

-[![Badge Discord]][Discord] - -
- - --- **[ 
 Install 
 
][Install]**  **[ 
 Configure 
 
][Configure]**  -**[ 
 Todo 
 
][Todo]**  **[ 
 Contribute 
 
][Contribute]** ---
- -### Related - -*For **Hyprland** without the* `land` *part,*
-*see **[Hypr]**, the **Xorg Window Manager**.* - -
- -### Notice -*This project is still in it's early stages*
-***Expect Some Bugs*** - -![Badge Workflow] + + +# Notice +This project is still in its early development, expect bugs. -*However once you get it working, it's pretty stable* +Once you get it working though, it's pretty stable.
### Help Wanted -**We needs testers!**
-*Try it out and report bugs or suggestions!* - - +Hyprland needs testers!
+Try it out and report bugs / suggestions! # Features - Easily expandable and readable codebase - Config reloaded instantly upon saving -- Parabolic Window Animations -- Workspaces Protocol Support -- Tiling / Floating / Fullscreen -- Window / Monitor Rules -- Socket - Based IPC -- Rounded Corners -- Damage Tracking ( *Experimental* ) -- Moving / Resizing -- Docks Support -- Fade In / Out -- Window Blur +- Parabolic window animations +- Workspaces protocol support +- Tiling / floating / fullscreen windows +- Window / monitor rules +- Socket-based IPC +- Rounded corners +- Damage tracking ( *Experimental* ) +- Moving / resizing +- Docks support +- Fade in / out +- Window blur
@@ -104,29 +87,17 @@
-**[WlRoots]** - -  *Their amazing library* - -**[TinyWl]** - -  *Showing how 2 do stuff* - -**[Sway]** - -  *Showing how 2 do stuff the **overkill** way* - -**[Vivarium]** +**[wlroots]** - *For their amazing library* -  *Showing how 2 do stuff the **simple** way* +**[tinywl]** - *For showing how 2 do stuff* -**[DWL]** +**[Sway]** - *For showing how 2 do stuff the overkill way* -  *Showing how 2 do stuff the **hacky** way* +**[Vivarium]** - *For showing how 2 do stuff the simple way* -**[Wayfire]** +**[dwl]** - *For showing how 2 do stuff the hacky way* -  *Showing how 2 do some **graphics** stuff* +**[Wayfire]** - *For showing how 2 do some graphics stuff* @@ -166,9 +137,10 @@ [Badge Workflow]: https://github.com/vaxerski/Hyprland/actions/workflows/ci.yaml/badge.svg -[Badge Discord]: https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white -[Badge Issues]: https://img.shields.io/github/issues/vaxerski/Hyprland?style=for-the-badge&label=%ef%bc%a9%ef%bd%93%ef%bd%93%ef%bd%95%ef%bd%85%ef%bd%93 -[Badge Pull Requests]: https://img.shields.io/github/issues-pr/vaxerski/Hyprland?style=for-the-badge&label=%ef%bc%b0%ef%bd%95%ef%bd%8c%ef%bd%8c%20%ef%bc%b2%ef%bd%85%ef%bd%91%ef%bd%95%ef%bd%85%ef%bd%93%ef%bd%94%ef%bd%93 -[Badge Language]: https://img.shields.io/github/languages/top/vaxerski/Hyprland?style=for-the-badge&label=%ef%bc%a3%ef%bc%8b%ef%bc%8b -[Badge License]: https://img.shields.io/badge/License-BSD_3--Clause-blue.svg?style=for-the-badge&label=%ef%bc%ac%ef%bd%89%ef%bd%83%ef%bd%85%ef%bd%8e%ef%bd%93%ef%bd%85 -[Badge Lines]: https://img.shields.io/tokei/lines/github/vaxerski/Hyprland?style=for-the-badge&label=%ef%bc%a3%ef%bd%8f%ef%bd%84%ef%bd%85 +[Badge Discord]: https://img.shields.io/badge/Join%20the-Discord%20server-6666ff +[Badge Issues]: https://img.shields.io/github/issues/vaxerski/Hyprland +[Badge Pull Requests]: https://img.shields.io/github/issues-pr/vaxerski/Hyprland +[Badge Language]: https://img.shields.io/github/languages/top/vaxerski/Hyprland +[Badge License]: https://img.shields.io/github/license/vaxerski/Hyprland +[Badge Lines]: https://img.shields.io/tokei/lines/github/vaxerski/Hyprland +[Badge Hi Mom]: https://img.shields.io/badge/Hi-mom!-ff69b4 -- cgit v1.2.3