update

docs/CONTRIBUTING.md

@@ -9,5 +9,11 @@ The process is straight-forward.
 - Write your changes (new theme, bug fixes, task in to-do, ...).
 - Create a Pull Request against the main branch of Nixy.
 
-> [!WARNING]
-> Don't push your host's files, secrets, or home configuration
+> [!TIP]
+> When wallpapers are added, run `./docs/scripts/compress_png.sh` and `./docs/scripts/create_preview_wallpapers.sh`
+
+> [!TIP]
+> To update the README, change the `./docs/src/README_template.md` and run `./docs/scripts/create_readme.sh`
+
+> [!IMPORTANT]
+> Don't push your host's folder

docs/TODO.md

@@ -6,7 +6,6 @@ feel free to contribute <3 ([CONTRIBUTING.md](CONTRIBUTING.md))
   - [~] Installation script ([install.sh](./scripts/install.sh) to test on a fresh install)
   - [~] Variables-template with defaults
   - [ ] Themes
-    - [ ] Upload new wallpapers
     - [ ] macOS theme
   - [ ] Tofi (Wofi, but terminal based)
   - [ ] Add Vim Keybindings to KEYBINDINGS.md

docs/WALLPAPERS.md

@@ -0,0 +1,39 @@
+# Wallpapers
+
+Wallpapers can be found in the ./home/wallpapers folder.
+
+| Name | Preview |
+| -- | -- |
+| 146.png | ![146.png](./home/wallpapers/146.png) |
+| 147.png | ![147.png](./home/wallpapers/147.png) |
+| astronaut.png | ![astronaut.png](./home/wallpapers/astronaut.png) |
+| aurore.png | ![aurore.png](./home/wallpapers/aurore.png) |
+| barcode.png | ![barcode.png](./home/wallpapers/barcode.png) |
+| cat-leaves.png | ![cat-leaves.png](./home/wallpapers/cat-leaves.png) |
+| cloud.png | ![cloud.png](./home/wallpapers/cloud.png) |
+| clouds.png | ![clouds.png](./home/wallpapers/clouds.png) |
+| clouds2.png | ![clouds2.png](./home/wallpapers/clouds2.png) |
+| coffee.png | ![coffee.png](./home/wallpapers/coffee.png) |
+| dark.png | ![dark.png](./home/wallpapers/dark.png) |
+| dark_cloud.png | ![dark_cloud.png](./home/wallpapers/dark_cloud.png) |
+| fuji-dark.png | ![fuji-dark.png](./home/wallpapers/fuji-dark.png) |
+| fuji-light.png | ![fuji-light.png](./home/wallpapers/fuji-light.png) |
+| galaxy.png | ![galaxy.png](./home/wallpapers/galaxy.png) |
+| house-cloud.png | ![house-cloud.png](./home/wallpapers/house-cloud.png) |
+| key.png | ![key.png](./home/wallpapers/key.png) |
+| lavender-cat.png | ![lavender-cat.png](./home/wallpapers/lavender-cat.png) |
+| lofi-computer.png | ![lofi-computer.png](./home/wallpapers/lofi-computer.png) |
+| lofi-urban.png | ![lofi-urban.png](./home/wallpapers/lofi-urban.png) |
+| magma.png | ![magma.png](./home/wallpapers/magma.png) |
+| mountains-black.png | ![mountains-black.png](./home/wallpapers/mountains-black.png) |
+| mountains.png | ![mountains.png](./home/wallpapers/mountains.png) |
+| nix.png | ![nix.png](./home/wallpapers/nix.png) |
+| problems.png | ![problems.png](./home/wallpapers/problems.png) |
+| sea.png | ![sea.png](./home/wallpapers/sea.png) |
+| space.png | ![space.png](./home/wallpapers/space.png) |
+| space2.png | ![space2.png](./home/wallpapers/space2.png) |
+| street.png | ![street.png](./home/wallpapers/street.png) |
+| sun.png | ![sun.png](./home/wallpapers/sun.png) |
+| tokyo.png | ![tokyo.png](./home/wallpapers/tokyo.png) |
+| train.png | ![train.png](./home/wallpapers/train.png) |
+| windows.png | ![windows.png](./home/wallpapers/windows.png) |

docs/scripts/compress_png.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-# Compress png files in ./docs/src
+# Compress png files in ./docs/src and ./home/wallpapers
 
 [[ -d "./docs" ]] || (echo "Folder ./docs not found" && exit 1)
 
@@ -14,6 +14,7 @@ for file in ./docs/src/*/*.png; do
   optipng "$file"
 done
 
+# Wallpapers
 for file in ./home/wallpapers/*.png; do
   optipng "$file"
 done

docs/scripts/create_preview_wallpapers.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+# Create WALLPAPERS.md to preview wallpapers in ./home/wallpapers
+
+WALLPAPERS_FOLDER="./home/wallpapers"
+WALLPAPERS_MD="./docs/WALLPAPERS.md"
+[[ -d "$WALLPAPERS_FOLDER" ]] || (echo "Wallpapers folder not found" && exit 1)
+
+echo "# Wallpapers" >"$WALLPAPERS_MD"
+echo "" >>"$WALLPAPERS_MD"
+echo "Wallpapers can be found in the ./home/wallpapers folder." >>"$WALLPAPERS_MD"
+echo "" >>"$WALLPAPERS_MD"
+echo "| Name | Preview |" >>"$WALLPAPERS_MD"
+echo "| -- | -- |" >>"$WALLPAPERS_MD"
+
+for file in $WALLPAPERS_FOLDER/*.png; do
+
+  echo "| $(basename $file) | ![$(basename $file)]($file) |" >>"$WALLPAPERS_MD"
+done
+
+pandoc -t commonmark_x "$WALLPAPERS_MD" -o "/tmp/wallpapers.md"
+mv "/tmp/wallpapers.md" "$WALLPAPERS_MD"

docs/src/README_template.md

@@ -49,6 +49,7 @@ sudo nixos-rebuild switch --flake ~/.config/nixos#yourhostname
 - [APPS.md](docs/APPS.md): Which apps are installed
 - [SCRIPTS.md](docs/SCRIPTS.md): Scripts that are available
 - [KEYBINDINGS.md](docs/KEYBINDINGS.md): Keybindings available in Hyprland
+- [WALLPAPERS.md](docs/WALLPAPERS.md): Preview of every wallpapers available
 
 - [TODO.md](docs/TODO.md): What's next (feel free to contribute)
 - [CONTRIBUTING.md](docs/CONTRIBUTING.md): How to contribute