From 532d584f781183eab99096682366db21d30bb248 Mon Sep 17 00:00:00 2001 From: Nathan <6182419+NathanC@users.noreply.github.com> Date: Sun, 2 Jun 2024 11:18:32 -0700 Subject: [PATCH] Update README.md with software choices, intro, and formatting tweaks --- README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 54 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 55287ba74..a4a80fcf7 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,23 @@ +Here’s what to expect: + + * A practical, accessible environment built for everyday hyprland use + * A user-friendly interface that doesn’t require you to go down the rabbit hole + * Keybinds are similar to that of Windows + +> [!NOTE] +> Dotfiles are heavily opinionated software. + + +
+

• overview •

+

+
+ + +
Notable features @@ -20,6 +37,7 @@ - **AI Assisstant**: ChatGPT and Google Gemini - **Autogenerated colors** based on your wallpaper using [Material colors](https://m3.material.io/styles/color/the-color-system/key-colors-tones) - **Animations** that are natural and fluid + - **Transparent Install** that asks approval for all commands/dep installs
Instructions @@ -42,6 +60,22 @@
+
+ Software overview + + - This dotfile setup is intended to work out of the box and has a fair amount of deps. Partial list of top level software used by hyprland here: + + | Software | Purpose | + | ------------- | ------------- | + | [AGS](https://github.com/Aylur/ags) | A GTK widget system, responsible for the status bar and various useful widgets | + | [anyrun](https://github.com/anyrun-org/anyrun) | Main app launcher/runner, default entry point for Super key, with AI integration and various actions | + | [Fuzzel](https://mark.stosberg.com/fuzzel-a-great-dmenu-and-rofi-altenrative-for-wayland/) | Secondary app launcher/runner | + | [wlogout](https://github.com/ArtsyMacaw/wlogout) | logout/lock/shutdown menu | + + + - For a more comprehensive list of dependencies, see [the dependencies conf used by the install script](https://github.com/end-4/dots-hyprland/blob/main/scriptdata/dependencies.conf) +
+
Help improve these dotfiles! @@ -49,7 +83,12 @@ - If you'd like to suggest fixes or a new widget, feel free to [open an issue](https://github.com/end-4/dots-hyprland/issues/new/choose)
-### [illogical_impulse](https://github.com/end-4/dots-hyprland/tree/illogical-impulse) +
+

• screenshots •

+

+
+ +### main branch (*illogical impulse*) **AI, on-screen indicators** ![image](https://github.com/end-4/dots-hyprland/assets/97237370/5e081770-0f1e-45c4-ad9c-3d19f488cd85) @@ -62,7 +101,7 @@ **Weeb powers** -![image](https://github.com/end-4/dots-hyprland/assets/97237370/711f5475-93ca-4097-a960-8047acc85cc7) +![image](https://github.com/end-4/dots-hyprland/assets/97237370/711f5475-93ca-4097-a960-8047acc85cc7✨) **Easy window management** @@ -97,9 +136,11 @@ Desktop Preview ---- +
+

• thank you •

+

+
-## Thank you - [@clsty](https://github.com/clsty) for making an actually good install script + many other stuff that I neglect - [@midn8hustlr](https://github.com/midn8hustlr) for greatly improving the color generation system - AGS: [Aylur's config](https://github.com/Aylur/dotfiles), [kotontrion's config](https://github.com/kotontrion/dotfiles) @@ -107,11 +148,18 @@ - AI bots for providing useful examples - Open source contributors for their software and ricers for their insipration (would be a too long list to put here!) -## Stonks +
+

• stonks •

+

+
+ - _thank you_ [![Stargazers over time](https://starchart.cc/end-4/dots-hyprland.svg?background=%230d1117&axis=%23e6edf3&line=%234759e7)](https://starchart.cc/end-4/dots-hyprland) +
+

✨ inspirations ✨

+

+
-## Inspirations - osu!lazer, Windows 11, Material Design 3, AvdanOS (concept)