From 4a958f206e0354d22b3264fb7099063e3abc7918 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 15:56:33 -0400 Subject: [PATCH 01/25] Formatted CONTRIBUTING.md --- CONTRIBUTING.md | 39 ++++++++++++++++++++++++++++++--------- 1 file changed, 30 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8a340270..97c9f42b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,15 +1,36 @@ + # Contributing -Thanks for considering contributing to Hyprland. +*Thank you for considering contributing to **Hyprland**.* -To get started, see the [Wiki](https://github.com/vaxerski/Hyprland/wiki/Contributing-&-Debugging) for debugging instructions. +
-Then, pick yourself an issue or implement your own suggestion! +## Development -As Hyprland is early dev, I recommend you stick to the bugs first, then new functionality. +Check the **[Wiki]** for debugging instructions. -# PR reqs -- Follow the code style -- Code must be readable -- Feature is useful / bugfix works -- Test your changes! Run it on bare metal and check if everything works. +Afterwards, pick yourself an **[Issue]** or *implement your own suggestion!* + +*As the **Hyprland** is still in its early stages,*
+*I'd recommend you stick to bug fixes first.* + +
+ +## Pull Requests + +- Please follow the ***code style*** + +- Code must be ***readable*** + +- **Features** should be ***useful*** + +- **Bugfixes** should ***works*** + +- ***Test your changes!*** + + *Run it on bare metal and check if everything works.* + + + +[Issue]: https://github.com/vaxerski/Hyprland/issues +[Wiki]: https://github.com/vaxerski/Hyprland/wiki/Contributing-&-Debugging From 079996d5bd9fe79ec515ca388cf429490db78040 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 16:08:57 -0400 Subject: [PATCH 02/25] Raw Links -> Link References --- CONTRIBUTING.md | 6 ++-- README.md | 73 +++++++++++++++++++++++++++++++++++++------------ 2 files changed, 59 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 97c9f42b..b5fb80ff 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,8 @@ Check the **[Wiki]** for debugging instructions. -Afterwards, pick yourself an **[Issue]** or *implement your own suggestion!* +Afterwards, pick yourself an **[Issue]**
+or *implement your own suggestion!* *As the **Hyprland** is still in its early stages,*
*I'd recommend you stick to bug fixes first.* @@ -28,7 +29,8 @@ Afterwards, pick yourself an **[Issue]** or *implement your own suggestion - ***Test your changes!*** - *Run it on bare metal and check if everything works.* + *Run it on bare metal and*
+ *check if everything works.* diff --git a/README.md b/README.md index b4854b2a..cc853176 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,27 @@

- -

- - - - - - - - + +![Banner] + +

+ +![Badge Workflow] +[![Badge Discord]][Discord] +![Badge Issues] +![Badge Pull Requests] +![Badge Language] +![Badge License] +![Badge Lines] +![Badge Hi] +



-People asked me to make a discord server, so join here! + +People asked me to make a discord server, so [join here!][Discord] +

+ Hyprland is a Dynamic Tiling Wayland Compositor in early development stages. -For Hyprland without the land part, see Hypr, the Xorg window manager. +For Hyprland without the land part, see [Hypr], the Xorg window manager. Hyprland is in early dev, expect some bugs. However, once you get it working, it's pretty stable. :P @@ -60,26 +67,26 @@ yay -S hyprland-git ## Manual building If your distro doesn't have Hyprland in its repositories, or you want to modify Hyprland, -please refer to the [Wiki Page](https://github.com/vaxerski/Hyprland/wiki/Installation) for the installation instructions. +please refer to the [Wiki Page][Install] for the installation instructions.
# Configuring -Head onto the [Wiki Page](https://github.com/vaxerski/Hyprland/wiki/Configuring-Hyprland) to see more. +Head onto the [Wiki Page][Configure] to see more. Hyprland without a config is a bad idea!
# Contributions -Very welcome! see [Contributing.md](https://github.com/vaxerski/Hyprland/blob/main/CONTRIBUTING.md) for instuctions and guidelines! +Very welcome! see [Contributing.md][Contribute] for instuctions and guidelines!
# Gallery -![Image1](https://i.imgur.com/ZA4Fa8R.png) -![Image2](https://i.imgur.com/BpXxM8H.png) +![Preview A] +![Preview B]
# Stars over time -[![Stars over time](https://starchart.cc/vaxerski/Hyprland.svg)](https://starchart.cc/vaxerski/Hyprland) +[![Stars Preview]][Stars] # Special thanks wlroots - for their amazing library @@ -93,3 +100,33 @@ vivarium - for showing how 2 do stuff the simple way dwl - for showing how 2 do stuff the hacky way wayfire - for showing how 2 do some graphics stuff + + + + +[Contribute]: https://github.com/vaxerski/Hyprland/blob/main/CONTRIBUTING.md +[Configure]: https://github.com/vaxerski/Hyprland/wiki/Configuring-Hyprland +[Install]: https://github.com/vaxerski/Hyprland/wiki/Installation +[Discord]: https://discord.gg/hQ9XvMUjjr +[Stars]: https://starchart.cc/vaxerski/Hyprland +[Hypr]: https://github.com/vaxerski/Hypr + + + + +[Stars Preview]: https://starchart.cc/vaxerski/Hyprland.svg +[Preview A]: https://i.imgur.com/ZA4Fa8R.png +[Preview B]: https://i.imgur.com/BpXxM8H.png +[Banner]: https://raw.githubusercontent.com/vaxerski/Hyprland/main/assets/hyprland.png + + + + +[Badge Workflow]: https://github.com/vaxerski/Hyprland/actions/workflows/ci.yaml/badge.svg +[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]: https://img.shields.io/badge/Hi-mom!-ff69b4 \ No newline at end of file From 065cdd40d6fdee8d8cc204f3f2cd8ee83357f63f Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 16:24:23 -0400 Subject: [PATCH 03/25] Adjusted Style --- README.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cc853176..fa13e395 100644 --- a/README.md +++ b/README.md @@ -80,15 +80,31 @@ Hyprland without a config is a bad idea! Very welcome! see [Contributing.md][Contribute] for instuctions and guidelines!
+
+ # Gallery ![Preview A] ![Preview B] -
-# Stars over time +
+ +--- + +
+ +# Stars Over Time + [![Stars Preview]][Stars] -# Special thanks +
+ +--- + +
+ +
+ +# Special Thanks wlroots - for their amazing library tinywl - for showing how 2 do stuff From 7230e92f362e7bb0170df6886944d14b0b395ad3 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 17:00:16 -0400 Subject: [PATCH 04/25] Adjusted Badges --- README.md | 49 ++++++++++++++++++++++++++++--------------------- 1 file changed, 28 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index fa13e395..d32421cc 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,31 @@ -

+ +![Badge Workflow] + +

![Banner] -

- -![Badge Workflow] -[![Badge Discord]][Discord] -![Badge Issues] -![Badge Pull Requests] -![Badge Language] -![Badge License] -![Badge Lines] -![Badge Hi] +
+
-

-

+ +![Badge License]![Badge Lines]![Badge Language]
+![Badge Pull Requests]![Badge Issues] + +
+ +[![Badge Discord]][Discord] + + +
+ +
+
People asked me to make a discord server, so [join here!][Discord] -

+
+
Hyprland is a Dynamic Tiling Wayland Compositor in early development stages. For Hyprland without the land part, see [Hypr], the Xorg window manager. @@ -139,10 +146,10 @@ wayfire - for showing how 2 do some graphics stuff [Badge Workflow]: https://github.com/vaxerski/Hyprland/actions/workflows/ci.yaml/badge.svg -[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]: https://img.shields.io/badge/Hi-mom!-ff69b4 \ No newline at end of file + +[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 From 5f81ab7c7483dc3dddd0736583675893ff069cc2 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 17:02:59 -0400 Subject: [PATCH 05/25] Adjusted Description --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d32421cc..9615f68e 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,6 @@ ![Banner]
-
- ![Badge License]![Badge Lines]![Badge Language]
![Badge Pull Requests]![Badge Issues] @@ -16,21 +14,22 @@ [![Badge Discord]][Discord] +
+
+ +***A Dynamic Wayland Tiling Compositor*** + +
+
-
-
+--- -People asked me to make a discord server, so [join here!][Discord] -
-
-Hyprland is a Dynamic Tiling Wayland Compositor in early development stages. For Hyprland without the land part, see [Hypr], the Xorg window manager. - Hyprland is in early dev, expect some bugs. However, once you get it working, it's pretty stable. :P Hyprland needs testers! Try it out and report bugs or suggestions! From 8e59cd8080fbbd6d8d8b2e6b355f3c3c9bf6233e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?= <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 17:03:53 -0400 Subject: [PATCH 06/25] Fixed Header Layout --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9615f68e..73d89c59 100644 --- a/README.md +++ b/README.md @@ -12,16 +12,15 @@
-[![Badge Discord]][Discord] - -
-
- ***A Dynamic Wayland Tiling Compositor***

+[![Badge Discord]][Discord] + +
+ --- From c2f2f7a83b00c88d9bc56d602d1b70c06ae5adb7 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 17:06:58 -0400 Subject: [PATCH 07/25] Added Quicklinks --- README.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 73d89c59..a67a7c14 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ --- +**[ 
 Configure 
 ][Configure]**  +**[ 
 Contribute 
 ][Contribute]** For Hyprland without the land part, see [Hypr], the Xorg window manager. @@ -75,15 +77,7 @@ If your distro doesn't have Hyprland in its repositories, or you want to modify please refer to the [Wiki Page][Install] for the installation instructions.
-# Configuring -Head onto the [Wiki Page][Configure] to see more. -Hyprland without a config is a bad idea! -
- -# Contributions -Very welcome! see [Contributing.md][Contribute] for instuctions and guidelines! -
From 4d3292168d4112085659265e5c02d29734f9f1bd Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 17:08:55 -0400 Subject: [PATCH 08/25] Linked Badges --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a67a7c14..0277cc95 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@
-![Badge License]![Badge Lines]![Badge Language]
-![Badge Pull Requests]![Badge Issues] +[![Badge License]][License]![Badge Lines]![Badge Language]
+[![Badge Pull Requests]][Pull Requests][![Badge Issues]][Issues]
@@ -126,6 +126,10 @@ wayfire - for showing how 2 do some graphics stuff [Stars]: https://starchart.cc/vaxerski/Hyprland [Hypr]: https://github.com/vaxerski/Hypr +[Pull Requests]: https://github.com/vaxerski/Hyprland/pulls +[Issues]: https://github.com/vaxerski/Hyprland/issues + +[License]: LICENSE From c71b0d74493b3a6ca5226ea100e19de5848cacc7 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 17:21:58 -0400 Subject: [PATCH 09/25] Formatted Features --- README.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 0277cc95..1bf42f40 100644 --- a/README.md +++ b/README.md @@ -21,13 +21,15 @@
-
--- **[ 
 Configure 
 ][Configure]**  **[ 
 Contribute 
 ][Contribute]** +--- + + For Hyprland without the land part, see [Hypr], the Xorg window manager. @@ -35,21 +37,20 @@ Hyprland is in early dev, expect some bugs. However, once you get it working, it Hyprland needs testers! Try it out and report bugs or suggestions! -# Key features - - Parabolic window animations - - Config reloaded instantly upon saving - - Easily expandable and readable codebase - - Rounded corners - - Window blur - - Workspaces Protocol support - - Damage tracking (experimental) - - Fade in/out - - Support for docks/whatever - - Window rules - - Monitor rules - - Socket-based IPC - - Tiling/floating/fullscreen windows - - Moving/resizing windows +# Features +- Easily expandable and readable codebase +- Config reloaded instantly upon saving +- Parabolic Window Animations +- Workspaces Protocol Support +- Tiling / Floating / Fullscreen +- Window / Monitor Rules +- Moving / Resizing +- Socket - Based IPC +- Rounded Corners +- Damage Tracking ( *Experimental* ) +- Docks Support +- Fade In / Out +- Window Blur # Major to-dos - Input Methods (wlr_input_method_v2) From 6c97cc5e7e13e379eafd75f0ac798ba2b4570fe3 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 17:30:24 -0400 Subject: [PATCH 10/25] Linked Thanks --- README.md | 44 +++++++++++++++++++++++++++++++++++--------- 1 file changed, 35 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1bf42f40..87bc9180 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,8 @@ please refer to the [Wiki Page][Install] for the installation instructions.
-# Gallery +## Gallery + ![Preview A] ![Preview B] @@ -92,7 +93,7 @@ please refer to the [Wiki Page][Install] for the installation instructions.
-# Stars Over Time +## Stars Over Time [![Stars Preview]][Stars] @@ -104,18 +105,33 @@ please refer to the [Wiki Page][Install] for the installation instructions.
-# Special Thanks -wlroots - for their amazing library +## Special Thanks -tinywl - for showing how 2 do stuff +
-sway - for showing how 2 do stuff the overkill way +**[WlRoots]** -vivarium - for showing how 2 do stuff the simple way +  *Their amazing library* -dwl - for showing how 2 do stuff the hacky way +**[TinyWl]** -wayfire - for showing how 2 do some graphics stuff +  *Showing how 2 do stuff* + +**[Sway]** + +  *Showing how 2 do stuff the overkill way* + +**[Vivarium]** + +  *Showing how 2 do stuff the simple way* + +**[DWL]** + +  *Showing how 2 do stuff the hacky way* + +**[Wayfire]** + +  *Showing how 2 do some graphics stuff* @@ -132,6 +148,16 @@ wayfire - for showing how 2 do some graphics stuff [License]: LICENSE + + + +[Vivarium]: https://github.com/inclement/vivarium +[WlRoots]: https://gitlab.freedesktop.org/wlroots/wlroots +[Wayfire]: https://github.com/WayfireWM/wayfire +[TinyWl]: https://gitlab.freedesktop.org/wlroots/wlroots/-/blob/master/tinywl/tinywl.c +[Sway]: https://github.com/swaywm/sway +[DWL]: https://github.com/djpohly/dwl + [Stars Preview]: https://starchart.cc/vaxerski/Hyprland.svg From 2de32ec5c552fc64b5b5fc0432e6371255f6143c Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 17:32:51 -0400 Subject: [PATCH 11/25] Formatting Adjustments --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 87bc9180..17a768cd 100644 --- a/README.md +++ b/README.md @@ -84,23 +84,24 @@ please refer to the [Wiki Page][Install] for the installation instructions. ## Gallery +
+ ![Preview A] -![Preview B]
---- +![Preview B] +

## Stars Over Time +
+ [![Stars Preview]][Stars]
- ---- -
@@ -119,19 +120,19 @@ please refer to the [Wiki Page][Install] for the installation instructions. **[Sway]** -  *Showing how 2 do stuff the overkill way* +  *Showing how 2 do stuff the **overkill** way* **[Vivarium]** -  *Showing how 2 do stuff the simple way* +  *Showing how 2 do stuff the **simple** way* **[DWL]** -  *Showing how 2 do stuff the hacky way* +  *Showing how 2 do stuff the **hacky** way* **[Wayfire]** -  *Showing how 2 do some graphics stuff* +  *Showing how 2 do some **graphics** stuff* From 8c4a5104cf37fc89d4f522e37970054d1d69e1a0 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 17:34:18 -0400 Subject: [PATCH 12/25] Moved Install / Contribute To Docs --- README.md | 18 ++---------------- CONTRIBUTING.md => docs/Contribute.md | 0 docs/Install.md | 15 +++++++++++++++ 3 files changed, 17 insertions(+), 16 deletions(-) rename CONTRIBUTING.md => docs/Contribute.md (100%) create mode 100644 docs/Install.md diff --git a/README.md b/README.md index 17a768cd..a58d9dcc 100644 --- a/README.md +++ b/README.md @@ -63,21 +63,6 @@ Hyprland needs testers! Try it out and report bugs or suggestions! - More config options for tweakers - Improve hyprctl -# Installation -I do not maintain any packages, but some kind people have made them for me. If I missed any, please let me know. - -**Warning:** since I am not the maintainer, I cannot guarantee that those packages will always work and be up to date. Use at your own disclosure. If they don't, try building manually. - -_Arch (AUR, -git)_ -``` -yay -S hyprland-git -``` -## Manual building -If your distro doesn't have Hyprland in its repositories, or you want to modify Hyprland, - -please refer to the [Wiki Page][Install] for the installation instructions. -
-
@@ -137,7 +122,6 @@ please refer to the [Wiki Page][Install] for the installation instructions. -[Contribute]: https://github.com/vaxerski/Hyprland/blob/main/CONTRIBUTING.md [Configure]: https://github.com/vaxerski/Hyprland/wiki/Configuring-Hyprland [Install]: https://github.com/vaxerski/Hyprland/wiki/Installation [Discord]: https://discord.gg/hQ9XvMUjjr @@ -147,6 +131,8 @@ please refer to the [Wiki Page][Install] for the installation instructions. [Pull Requests]: https://github.com/vaxerski/Hyprland/pulls [Issues]: https://github.com/vaxerski/Hyprland/issues +[Contribute]: docs/Contribute.md +[Install]: docs/Install.md [License]: LICENSE diff --git a/CONTRIBUTING.md b/docs/Contribute.md similarity index 100% rename from CONTRIBUTING.md rename to docs/Contribute.md diff --git a/docs/Install.md b/docs/Install.md new file mode 100644 index 00000000..71abd1a9 --- /dev/null +++ b/docs/Install.md @@ -0,0 +1,15 @@ +# Installation +I do not maintain any packages, but some kind people have made them for me. If I missed any, please let me know. + +**Warning:** since I am not the maintainer, I cannot guarantee that those packages will always work and be up to date. Use at your own disclosure. If they don't, try building manually. + +_Arch (AUR, -git)_ +``` +yay -S hyprland-git +``` +## Manual building +If your distro doesn't have Hyprland in its repositories, or you want to modify Hyprland, + +please refer to the [Wiki Page][Install] for the installation instructions. +
+ From 2f7cc404db0844d734f74979ef60eed6df4ecde1 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 17:34:52 -0400 Subject: [PATCH 13/25] Added Install To Quicklinks --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index a58d9dcc..1764c41a 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ --- +**[ 
 Install 
 ][Install]**  **[ 
 Configure 
 ][Configure]**  **[ 
 Contribute 
 ][Contribute]** From 1e98e78ad029c7c7641e8e217861a6a1377d138d Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 17:36:58 -0400 Subject: [PATCH 14/25] Moved TODO To Projects --- README.md | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 1764c41a..d66dde8f 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ **[ 
 Install 
 ][Install]**  **[ 
 Configure 
 ][Configure]**  +**[ 
 Todo 
 ][Todo]**  **[ 
 Contribute 
 ][Contribute]** --- @@ -53,22 +54,13 @@ Hyprland needs testers! Try it out and report bugs or suggestions! - Fade In / Out - Window Blur -# Major to-dos - - Input Methods (wlr_input_method_v2) - - Animations (some new, like workspace) - - Fix electron rendering issues - - Optimization - - Fix weird scroll on XWayland (if possible) - - Become sane - - STABILITY - - More config options for tweakers - - Improve hyprctl - +
+
-## Gallery +# Gallery
@@ -81,7 +73,7 @@ Hyprland needs testers! Try it out and report bugs or suggestions!

-## Stars Over Time +# Stars Over Time
@@ -92,7 +84,7 @@ Hyprland needs testers! Try it out and report bugs or suggestions!
-## Special Thanks +# Special Thanks
@@ -131,6 +123,7 @@ Hyprland needs testers! Try it out and report bugs or suggestions! [Pull Requests]: https://github.com/vaxerski/Hyprland/pulls [Issues]: https://github.com/vaxerski/Hyprland/issues +[Todo]: https://github.com/vaxerski/Hyprland/projects?type=beta [Contribute]: docs/Contribute.md [Install]: docs/Install.md From 95a4f1a3324c2b0fb1a272f6e4bf2420e6151354 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 17:42:04 -0400 Subject: [PATCH 15/25] Formatted Notes --- README.md | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d66dde8f..4577277e 100644 --- a/README.md +++ b/README.md @@ -31,14 +31,30 @@ --- + +### 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*** + +*However Once you get it working, it's pretty stable* + +
+ +### Help Wanted + +**We needs testers!**
+*Try it out and report bugs or suggestions!* +
-For Hyprland without the land part, see [Hypr], the Xorg window manager. - -Hyprland is in early dev, expect some bugs. However, once you get it working, it's pretty stable. :P - -Hyprland needs testers! Try it out and report bugs or suggestions! - # Features - Easily expandable and readable codebase - Config reloaded instantly upon saving From 36e70fe7bc3ac38e9c19f55aaea72094503bf8af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?= <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 17:42:57 -0400 Subject: [PATCH 16/25] Adjusted Spacing --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4577277e..65effd91 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,8 @@ --- - +
+ ### Related *For **Hyprland** without the* `land` *part,*
From 280d8a71ca8c91b764660cb5a471bd6e96bd3629 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 17:49:06 -0400 Subject: [PATCH 17/25] Formatted Installation --- README.md | 1 - docs/Install.md | 54 +++++++++++++++++++++++++++++++++++++++++-------- 2 files changed, 46 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4577277e..4da8951c 100644 --- a/README.md +++ b/README.md @@ -132,7 +132,6 @@ [Configure]: https://github.com/vaxerski/Hyprland/wiki/Configuring-Hyprland -[Install]: https://github.com/vaxerski/Hyprland/wiki/Installation [Discord]: https://discord.gg/hQ9XvMUjjr [Stars]: https://starchart.cc/vaxerski/Hyprland [Hypr]: https://github.com/vaxerski/Hypr diff --git a/docs/Install.md b/docs/Install.md index 71abd1a9..dd8aa968 100644 --- a/docs/Install.md +++ b/docs/Install.md @@ -1,15 +1,53 @@ + # Installation -I do not maintain any packages, but some kind people have made them for me. If I missed any, please let me know. -**Warning:** since I am not the maintainer, I cannot guarantee that those packages will always work and be up to date. Use at your own disclosure. If they don't, try building manually. +
-_Arch (AUR, -git)_ -``` +## Packages + +*I do not maintain any packages, however*
+*some kind people have made them for me.* + +
+ +**If I missed any, please let me know.** + +
+ +### Warning + +Since I am not the maintainer, I cannot
+guarantee that those packages will
+always work and be up to date. + +
+ +***Use at your own disclosure.***
+*If they don't, try building manually.* + +
+ +#### Arch ( AUR / -git ) + +```sh yay -S hyprland-git ``` -## Manual building -If your distro doesn't have Hyprland in its repositories, or you want to modify Hyprland, -please refer to the [Wiki Page][Install] for the installation instructions. -
+
+ +--- + +
+ +## Building + +If your distro doesn't have **Hyprland** in its repositories,
+or you want to modify it, please refer to the **[Wiki Pages][Install]**
+for the installation instructions. + + + + +[Install]: https://github.com/vaxerski/Hyprland/wiki/Installation + From fe850421c97e59902c859fbad49cd634b7df06f8 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 17:53:53 -0400 Subject: [PATCH 18/25] Moved Badge --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2e0b7e56..b094d1d9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,3 @@ - -![Badge Workflow] -
![Banner] @@ -45,6 +42,8 @@ *This project is still in it's early stages*
***Expect Some Bugs*** +![Badge Workflow] + *However Once you get it working, it's pretty stable*
From 24819deae44cc174076bf67c07c4567bc8b4eb76 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?= <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 18:14:17 -0400 Subject: [PATCH 19/25] Fixed Typos --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b094d1d9..418a3e16 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ ### Related *For **Hyprland** without the* `land` *part,*
-*see **[Hypr]**, the Xorg window manager.* +*see **[Hypr]**, the **Xorg Window Manager**.*
@@ -44,7 +44,7 @@ ![Badge Workflow] -*However Once you get it working, it's pretty stable* +*However once you get it working, it's pretty stable*
@@ -62,10 +62,10 @@ - Workspaces Protocol Support - Tiling / Floating / Fullscreen - Window / Monitor Rules -- Moving / Resizing - Socket - Based IPC - Rounded Corners - Damage Tracking ( *Experimental* ) +- Moving / Resizing - Docks Support - Fade In / Out - Window Blur 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: [PATCH 20/25] Typos, badges and info rewrites --- README.md | 102 ++++++++++++++++++++---------------------------------- 1 file changed, 37 insertions(+), 65 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] - -
- -***A Dynamic Wayland Tiling Compositor*** - -
-
- +[![Badge License]][License] ![Badge Lines] ![Badge Language] [![Badge Pull Requests]][Pull Requests] [![Badge Issues]][Issues] ![Badge Hi Mom]
[![Badge Discord]][Discord] -
+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. +
+
--- **[ 
 Install 
 ][Install]**  **[ 
 Configure 
 ][Configure]**  -**[ 
 Todo 
 ][Todo]**  **[ 
 Contribute 
 ][Contribute]** ---
+ +
-### Related +# Notice +This project is still in its early development, expect bugs. -*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] - -*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]** +**[wlroots]** - *For their amazing library* -  *Their amazing library* +**[tinywl]** - *For showing how 2 do stuff* -**[TinyWl]** +**[Sway]** - *For showing how 2 do stuff the overkill way* -  *Showing how 2 do stuff* +**[Vivarium]** - *For showing how 2 do stuff the simple way* -**[Sway]** +**[dwl]** - *For showing how 2 do stuff the hacky way* -  *Showing how 2 do stuff the **overkill** way* - -**[Vivarium]** - -  *Showing how 2 do stuff the **simple** way* - -**[DWL]** - -  *Showing how 2 do stuff the **hacky** way* - -**[Wayfire]** - -  *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 From ec76b44700b53175b910d3a7138c540a0369aa8f Mon Sep 17 00:00:00 2001 From: vaxerski <43317083+vaxerski@users.noreply.github.com> Date: Tue, 19 Apr 2022 11:20:08 +0200 Subject: [PATCH 21/25] rewrite parts of the docs/install --- docs/Install.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/docs/Install.md b/docs/Install.md index dd8aa968..592a27f7 100644 --- a/docs/Install.md +++ b/docs/Install.md @@ -5,8 +5,7 @@ ## Packages -*I do not maintain any packages, however*
-*some kind people have made them for me.* +*I do not maintain any packages, but some kind people have made them for me.*
@@ -14,16 +13,14 @@
-### Warning +## Notice -Since I am not the maintainer, I cannot
-guarantee that those packages will
-always work and be up to date. +Since I am not the maintainer, I cannot guarantee that those packages will always work and be up to date.
***Use at your own disclosure.***
-*If they don't, try building manually.* +*If they don't work, try building manually.*
@@ -32,7 +29,6 @@ always work and be up to date. ```sh yay -S hyprland-git ``` -
--- @@ -41,9 +37,7 @@ yay -S hyprland-git ## Building -If your distro doesn't have **Hyprland** in its repositories,
-or you want to modify it, please refer to the **[Wiki Pages][Install]**
-for the installation instructions. +If your distro doesn't have **Hyprland** in its repositories, or you want to modify it, please refer to the **[Wiki Page][Install]** for the installation instructions. From e01247c10cb56c0e9c1548e61f80858956f8b520 Mon Sep 17 00:00:00 2001 From: vaxerski <43317083+vaxerski@users.noreply.github.com> Date: Tue, 19 Apr 2022 11:22:28 +0200 Subject: [PATCH 22/25] rewrite parts of docs/Contribute --- docs/Contribute.md | 23 +++++++++-------------- 1 file changed, 9 insertions(+), 14 deletions(-) diff --git a/docs/Contribute.md b/docs/Contribute.md index b5fb80ff..c30d9925 100644 --- a/docs/Contribute.md +++ b/docs/Contribute.md @@ -1,36 +1,31 @@ # Contributing -*Thank you for considering contributing to **Hyprland**.* +*Thank you for considering contributing to Hyprland.*
## Development -Check the **[Wiki]** for debugging instructions. +Check the [Wiki] for debugging instructions. -Afterwards, pick yourself an **[Issue]**
-or *implement your own suggestion!* +Afterwards, pick yourself an [Issue] or implement your own suggestion. -*As the **Hyprland** is still in its early stages,*
-*I'd recommend you stick to bug fixes first.* +*As Hyprland is still in its early stages of development, I'd recommend you stick to bug fixes first.*
## Pull Requests -- Please follow the ***code style*** +- Please follow the code style -- Code must be ***readable*** +- Code must be readable -- **Features** should be ***useful*** +- Features should be useful -- **Bugfixes** should ***works*** +- Test your changes! -- ***Test your changes!*** - - *Run it on bare metal and*
- *check if everything works.* + *Run it on bare metal and check if everything works.* From da59b932749319b96380c5cb212ed20e1db0cbdc Mon Sep 17 00:00:00 2001 From: vaxerski <43317083+vaxerski@users.noreply.github.com> Date: Tue, 19 Apr 2022 11:26:34 +0200 Subject: [PATCH 23/25] cleanup --- README.md | 4 +--- docs/Contribute.md | 4 ---- docs/Install.md | 12 ------------ 3 files changed, 1 insertion(+), 19 deletions(-) diff --git a/README.md b/README.md index e1fc796a..ea1efa7e 100644 --- a/README.md +++ b/README.md @@ -29,9 +29,7 @@ For Hyprland without the `land` part, see [Hypr], the Xorg window manager. # Notice This project is still in its early development, expect bugs. -Once you get it working though, it's pretty stable. - -
+Once you get it working though, it's pretty stable.
### Help Wanted diff --git a/docs/Contribute.md b/docs/Contribute.md index c30d9925..c921ce40 100644 --- a/docs/Contribute.md +++ b/docs/Contribute.md @@ -3,8 +3,6 @@ *Thank you for considering contributing to Hyprland.* -
- ## Development Check the [Wiki] for debugging instructions. @@ -13,8 +11,6 @@ Afterwards, pick yourself an [Issue] or implement your own suggestion. *As Hyprland is still in its early stages of development, I'd recommend you stick to bug fixes first.* -
- ## Pull Requests - Please follow the code style diff --git a/docs/Install.md b/docs/Install.md index 592a27f7..2b8c3a7e 100644 --- a/docs/Install.md +++ b/docs/Install.md @@ -1,39 +1,27 @@ # Installation -
- ## Packages *I do not maintain any packages, but some kind people have made them for me.* -
- **If I missed any, please let me know.** -
- ## Notice Since I am not the maintainer, I cannot guarantee that those packages will always work and be up to date. -
- ***Use at your own disclosure.***
*If they don't work, try building manually.* -
- #### Arch ( AUR / -git ) ```sh yay -S hyprland-git ``` -
--- -
## Building From c7946f36d2f20af654a4e87085f765ea9a16ae56 Mon Sep 17 00:00:00 2001 From: vaxerski <43317083+vaxerski@users.noreply.github.com> Date: Tue, 19 Apr 2022 12:41:09 +0200 Subject: [PATCH 24/25] forgot the workflow badge --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ea1efa7e..e4d82c9a 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@
-[![Badge License]][License] ![Badge Lines] ![Badge Language] [![Badge Pull Requests]][Pull Requests] [![Badge Issues]][Issues] ![Badge Hi Mom]
+![Badge Workflow] [![Badge License]][License] ![Badge Lines] ![Badge Language] [![Badge Pull Requests]][Pull Requests] [![Badge Issues]][Issues] ![Badge Hi Mom]
[![Badge Discord]][Discord]
From 63cf99d819784fbd2d12a9574b62b7be4f0bc366 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?= <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Tue, 19 Apr 2022 07:38:08 -0400 Subject: [PATCH 25/25] Fixed Syntax --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e4d82c9a..bc3db701 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,21 @@
-![Badge Workflow] [![Badge License]][License] ![Badge Lines] ![Badge Language] [![Badge Pull Requests]][Pull Requests] [![Badge Issues]][Issues] ![Badge Hi Mom]
+![Badge Workflow] +[![Badge License]][License] +![Badge Lines] +![Badge Language] +[![Badge Pull Requests]][Pull Requests] +[![Badge Issues]][Issues] +![Badge Hi Mom]
[![Badge Discord]][Discord] +
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. +

@@ -27,6 +35,7 @@ For Hyprland without the `land` part, see [Hypr], the Xorg window manager. # Notice + This project is still in its early development, expect bugs. Once you get it working though, it's pretty stable.
@@ -37,6 +46,7 @@ Hyprland needs testers!
Try it out and report bugs / suggestions! # Features + - Easily expandable and readable codebase - Config reloaded instantly upon saving - Parabolic window animations @@ -51,7 +61,6 @@ Try it out and report bugs / suggestions! - Fade in / out - Window blur -