Add README.md

README.md

@@ -0,0 +1,110 @@
+<h1 align="center">
+   <img src="./.repo/assets/logo/fruesos-logo.png" width="100px" />
+   <br>
+      peprolinbot's Flakes
+   <br>
+      <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/palette/mocha.png" width="600px" /> <br>
+   <div align="center">
+
+<div align="center">
+      <p></p>
+      <div align="center">
+         <a = href="https://nixos.org">
+            <img src="https://img.shields.io/badge/NixOS-25.11-blue.svg?style=for-the-badge&labelColor=303446&logo=NixOS&logoColor=white&color=91D7E3">
+         </a>
+         <a href="https://git.peprolinbot.com/peprolinbot/frues-clan/src/branch/main/LICENSE">
+            <img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&colorA=313244&colorB=F5A97F&logo=unlicense&logoColor=F5A97F&"/>
+         </a>
+      </div>
+      <br>
+   </div>
+</h1>
+
+<br>
+</div>
+
+### 🖼️ Desktop config screenshots
+
+<p align="center">
+   <img src="./.repo/assets/screenshots/1.png" /> <br>
+   Screenshots last updated <b>27th December 2025</b>
+</p>
+
+# 🗃️ Overview
+
+### 📚 Layout
+
+This repo uses [clan](https://clan.lol), so that drives the repo structure a
+lot. Check [their docs](https://docs.clan.lol) for more info.
+
+- [flake.nix](flake.nix) base of the configuration
+- [modules](modules) 🍱 modules reused accross various configurations
+- [hosts](machines) 🌳 per-machine
+- [users](users) 👥 user-specific configurations
+  - [pedro/home-configuration](users/pedro/home-configuration) 🏠 my
+    [Home-Manager](https://github.com/nix-community/home-manager) config
+
+### 📓 Components
+
+|                             |                                  NixOS + Hyprland                                   |
+| --------------------------- | :---------------------------------------------------------------------------------: |
+| **Window Manager**          |                                [Hyprland][Hyprland]                                 |
+| **Bar**                     |                                  [Waybar][Waybar]                                   |
+| **Application Launcher**    |                                  [fuzzel][fuzzel]                                   |
+| **Notification Daemon**     |                                    [mako][mako]                                     |
+| **Terminal Emulator**       |                                   [Kitty][Kitty]                                    |
+| **Shell**                   |             [zsh][zsh] + [oh-my-zsh][oh-my-zsh] + [Starship][Starship]              |
+| **Text Editor**             |                       [VSCodium][VSCodium] + [Neovim][Neovim]                       |
+| **network management tool** | [NetworkManager][NetworkManager] + [network-manager-applet][network-manager-applet] |
+| **System resource monitor** |                                    [Btop][Btop]                                     |
+| **File Manager**            |                             [nemo][nemo] + [yazi][yazi]                             |
+| **Fonts**                   |                              [Nerd fonts][Nerd fonts]                               |
+| **Color Scheme**            |                   [Catppuccin][Catppuccin] with [stylix][stylix]                    |
+| **Cursor**                  |                      [Catppuccin cursors][catppuccin-cursors]                       |
+| **Icons**                   |              [catppuccin-papirus-folders][catppuccin-papirus-folders]               |
+| **Lockscreen**              |                                [hyprlock][hyprlock]                                 |
+| **Image Viewer**            |                                   [vimiv][vimiv]                                    |
+| **Media Player**            |                                     [mpv][mpv]                                      |
+| **Music Player**            |                          [spotify_player][spotify_player]                           |
+| **Screenshot Software**     |                               [grimblast][grimblast]                                |
+| **Screen Recording**        |                             [wf-recorder][wf-recorder]                              |
+| **Clipboard**               |                         [wl-clip-persist][wl-clip-persist]                          |
+| **Color Picker**            |                              [hyprpicker][hyprpicker]                               |
+
+<!-- end of page, send back to the top -->
+
+<div align="right">
+  <a href="#readme">Back to the Top</a>
+</div>
+
+<!-- Links -->
+
+[Hyprland]: https://github.com/hyprwm/Hyprland
+[Kitty]: https://github.com/kovidgoyal/kitty
+[Starship]: https://github.com/starship/starship
+[Waybar]: https://github.com/Alexays/Waybar
+[fuzzel]: https://codeberg.org/dnkl/fuzzel>
+[Btop]: https://github.com/aristocratos/btop
+[nemo]: https://github.com/linuxmint/nemo
+[yazi]: https://github.com/sxyazi/yazi
+[zsh]: https://ohmyz.sh/
+[oh-my-zsh]: https://ohmyz.sh/
+[hyprlock]: https://github.com/hyprwm/hyprlock
+[spotify_player]: https://github.com/aome510/spotify-player
+[mpv]: https://github.com/mpv-player/mpv
+[VSCodium]: https://vscodium.com/
+[Neovim]: https://github.com/neovim/neovim
+[grimblast]: https://github.com/hyprwm/contrib
+[vimiv]: https://karlch.github.io/vimiv/
+[mako]: https://github.com/emersion/mako
+[Nerd fonts]: https://github.com/ryanoasis/nerd-fonts
+[NetworkManager]: https://wiki.gnome.org/Projects/NetworkManager
+[network-manager-applet]: https://gitlab.gnome.org/GNOME/network-manager-applet/
+[wl-clip-persist]: https://github.com/Linus789/wl-clip-persist
+[wf-recorder]: https://github.com/ammen99/wf-recorder
+[hyprpicker]: https://github.com/hyprwm/hyprpicker
+[Catppuccin]: https://github.com/catppuccin/catppuccin
+[catppuccin-papirus-folders]: https://github.com/catppuccin/papirus-folders
+[catppuccin-cursors]: https://github.com/catppuccin/cursors
+[maxfetch]: https://github.com/jobcmax/maxfetch
+[stylix]: https://github.com/nix-community/stylix