docs: update description text

InioX · Oct 10, 2023 · a69d69a · a69d69a
1 parent 34d1416
commit a69d69a
Showing 1 changed file with 76 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -17,7 +17,14 @@
     <sub>My nixos dotfiles with  <a href="https://github.com/nix-community/home-manager">Home Manager</a>
 </div>
 
-## 📷 Showcase
+<h2 class="showcase">
+     <sub>
+          <img  src="https://github.com/InioX/dotfiles/assets/81521595/eae80830-f035-4c03-8901-f481c858dcc5"
+           height="25"
+           width="25">
+     </sub>
+     Showcase
+</h2>
 <details><summary>Changes</summary>
 <h2>
     Waybar <sup><a href="https://github.com/InioX/dotfiles/commit/fe65d8b40df74ed81d642d476181c75a6ae46f19">(fe65d8b) - 29/08/2023</a></sup>
@@ -32,10 +39,7 @@
 </h2>
 </details>
 
-> **Warning**
-> The showcase may be outdated and look differently.
-
-<details><summary>Click to show</summary>
+<details><summary>Showcase</summary>
 <p>
 
 <img src="https://user-images.githubusercontent.com/81521595/236634805-15e68f9b-44a5-4efc-b275-0eb1f6a28bd9.gif" width="320" height="180"/>
@@ -45,34 +49,33 @@
 </p>
 </details>
 
-## ℹ️ Description
-Welcome to my dotfiles! My main goal was to have dynamic colors based on the wallpaper. However, i couldnt figure of a good way to make this work with [Home Manager](https://github.com/nix-community/home-manager) without having to rebuild everytime... The folder structure is pretty messy but i did try my best to explain it below.
+> **Warning**
+> The showcase may be outdated and look differently.
 
-<details><summary>Click to show</summary>
-
-```ini
-📂 dotfiles/
-├── ❄️ flake.nix
-├── 📂 dotfiles/ # All dotfiles for programs, in a folder for compability with arch
-│    ├── 📁 config/ # My dotfiles except for those generated from templates
-│    ├── 📁 templates/ # Additional stuff generated with matugen
-│    └── 📁 wallpapers/ # All my wallpapers are stored here
-├── 📂 modules/ # All the modules
-│   ├── 📁 apps/ # GUI apps/tools
-│   ├── 📁 cli/ # CLI apps/tools
-│   ├── 📁 system/ # Main system configuration
-│   ├── 📁 home/ # Home Manager configuration
-│   └── 📁 desktop/ # DE/WM configurations
-│        └── 📁 addons/ # Additional stuff for desktop
-└── 📂 hosts/ # Host specific configurations
-    └── 📂 <hostName>/
-        ├── 📄 default.nix
-        └── 📄 hardware.nix
-```
+<h2 class="description">
+     <sub>
+          <img  src="https://github.com/InioX/dotfiles/assets/81521595/aba782c2-f45a-4ee7-b511-45971ea751e6"
+           height="25"
+           width="25">
+     </sub>
+     Description
+</h2>
 
-</details>
+Welcome to my dotfiles! My main goal was to have dynamic colors based on the wallpaper exactly like with [Material Design 3](https://m3.material.io/). However, i couldnt figure of a good way to make this work with [Home Manager](https://github.com/nix-community/home-manager) without having to rebuild everytime, so my dotfiles may be a bit messy and hard to understand.
 
-## :package: Installation
+The `dotfiles/config` folder is there for compability reasons for arch, some files are missing from the folder because theyre generated by [Matugen](https://github.com/InioX/matugen) from `dotfiles/templates`.
+
+<h2 class="installation">
+     <sub>
+          <img  src="https://github.com/InioX/dotfiles/assets/81521595/37663833-5d34-492e-95ea-73528184a42b"
+           height="25"
+           width="25">
+     </sub>
+     Installation
+</h2>
+
+<details><summary>Click to show</summary>
+
 First, clone the repository
 ```shell
 git clone https://github.com/InioX/dotfiles
@@ -107,9 +110,26 @@ matugen image /path/to/wallpaper/ -v <other-options>
 > **Note**
 > Read matugen documentation [here](https://github.com/InioX/matugen#usage).
 
-## 🛠️ Usage
+</details>
+
+<h2 class="usage">
+     <sub>
+          <img  src="https://github.com/InioX/dotfiles/assets/81521595/4e2f040e-977b-43e2-8465-6915817475c7"
+           height="25"
+           width="25">
+     </sub>
+     Usage
+</h2>
+
+<h3 class="adding-new-hosts">
+     <sub>
+          <img  src="https://github.com/InioX/dotfiles/assets/81521595/7da759cf-08f0-4a09-a1a2-6f4ea59368c9"
+           height="20"
+           width="20">
+     </sub>
+     Adding new hosts
+</h3>
 
-### Adding new hosts
 <details><summary>Click to show</summary>
 
 The name of the folder should be your hostname and it should be located in `hosts/<hostName>`. Every host folder should contain a `default.nix` file and `hardware.nix`.
@@ -174,9 +194,23 @@ in {
 
 </details>
 
-## ⚠️ Issues
+<h2 class="issues">
+     <sub>
+          <img  src="https://github.com/InioX/dotfiles/assets/81521595/b9acc606-db85-4589-a5a4-3db0172068f0"
+           height="25"
+           width="25">
+     </sub>
+     Issues
+</h2>
 
-### Broken bootloader after dual booting Windows
+<h3 class="broken-bootloader-after-dual-booting-windows">
+     <sub>
+          <img  src="https://github.com/InioX/dotfiles/assets/81521595/8cf41faa-bd05-4e6c-91f6-b5948ddf48e4"
+           height="20"
+           width="20">
+     </sub>
+     Broken bootloader after dual booting Windows
+</h3>
 
 <details><summary>Click to show</summary>
 
@@ -213,7 +247,14 @@ in {
 
 </details>
 
-## ✨ Acknowledgment
+<h2 class="acknowledgements">
+     <sub>
+          <img  src="https://github.com/InioX/dotfiles/assets/81521595/353caef1-d2bd-4a10-a709-c64b35465e65"
+           height="25"
+           width="25">
+     </sub>
+     Acknowledgements
+</h2>
 
 First, special thanks to [jakehamilton](https://github.com/jakehamilton), my config is **heavily** inspired by [him](https://github.com/jakehamilton/config).