📚 docs(README): added summaries to make the file shorter and less bloated. also added the config link to the programs

This commit is contained in:
Sergio Laín 2023-10-27 14:15:39 +02:00
parent 1134afad7d
commit 90b108f637
No known key found for this signature in database
GPG key ID: 14C9B8080681777B
2 changed files with 44 additions and 32 deletions

76
.github/README.md vendored
View file

@ -25,56 +25,63 @@ This repo is always changing, so I may add new stuff in the future. If you encou
Here is some _small_ information about my setup: Here is some _small_ information about my setup:
#### System <details>
<summary><b>🐧 System</b></summary>
- **OS**: Arch Linux (btw) - **OS**: Arch Linux ([btw](https://www.reddit.com/r/archlinux/comments/6hv94x/has_anyone_seen_arch/))
- **Window Manager**: Hyprland - **Window Manager**: Hyprland ([Config](../.config/hypr/))
- **Panel**: Waybar - **Panel**: Waybar ([Config](../.config/waybar/))
- **Notification Daemon/Center**: swaync - **Terminal Emulator**: Kitty ([Config](../.config/kitty/))
- **Application Launcher**: Rofi - **Notification Daemon/Center**: swaync ([Config](../.config/swaync/))
- **Audio Daemon**: Pipewire - **Application Launcher**: Rofi ([Config](../.config/rofi/))
- **Audio Daemon**: Pipewire ([Config](../.config/pipewire/))
- **Firewall**: ufw - **Firewall**: ufw
- **AUR Helper**: yay - **AUR Helper**: yay
- **Clipboard Manager**: wl-clipboard (with cliphist) - **Clipboard Manager**: wl-clipboard (with cliphist)
- **Wallpaper Switcher**: swww - **Wallpaper Switcher**: swww
- **Lock Screen**: swaylock-effects - **Lock Screen**: swaylock-effects ([Config](../.config/sway/))
- **Idle Timeout**: swayidle - **Idle Timeout**: swayidle ([Config](../.config/sway/))
- **Color Picker**: Hyprpicker - **Color Picker**: Hyprpicker
- **Recording Tool**: wf-recorder - **Recording Tool**: wf-recorder
- **Screenshot Tool**: Hyprshot - **Screenshot Tool**: Hyprshot
- **Logout Menu**: wleave - **Logout Menu**: wleave ([Config](../.config/wleave/))
#### CLI/TUI </details>
- **Terminal Emulator**: Kitty <details>
- **Shell**: Fish <summary><b>🖥️ CLI/TUI Apps</b></summary>
- **Shell Prompt**: Starship
- **Shell**: Fish ([Config](../.config/fish/))
- **Shell Prompt**: Starship ([Config](../.config/starship/))
- **Shell History**: [Atuin](https://github.com/atuinsh/atuin) ([Config](../.config/atuin/)) - **Shell History**: [Atuin](https://github.com/atuinsh/atuin) ([Config](../.config/atuin/))
- **CD Replacement**: zoxide - **CD Replacement**: zoxide
- **LS Replacement**: eza - **LS Replacement**: eza
- **Cat Replacement**: bat - **Cat Replacement**: bat ([Config](../.config/bat/))
- **Help Pages**: Navi / TLDR - **Help Pages**: Navi / TLDR ([Config](../.config/navi/))
- **Fuzzy File Finder**: Fzf - **Fuzzy File Finder**: Fzf
- **Fuzzy Word Finder**: Ripgrep - **Fuzzy Word Finder**: Ripgrep ([Config](../.config/rg/))
- **Editor**: Neovim - **Editor**: Neovim ([Config](../.config/nvim/))
- **File Manager**: Yazi - **File Manager**: Yazi ([Config](../.config/yazi/))
- **Git UI**: Lazygit - **Git UI**: Lazygit ([Config](../.config/lazygit/))
- **Npm Manager UI**: Lazynpm - **Npm Manager UI**: Lazynpm
- **Docker UI**: Lazydocker - **Docker UI**: Lazydocker
- **Audio Visualizer**: Cava - **Audio Visualizer**: Cava ([Config](../.config/cava/))
- **System Monitor**: btop - **System Monitor**: btop ([Config](../.config/btop/))
- **GPU Monitor**: nvtop - **GPU Monitor**: nvtop
- **System Fetch**: Neofetch - **System Fetch**: Neofetch ([Config](../.config/neofetch/))
- **Git Fetch**: Onefetch - **Git Fetch**: Onefetch
- **Keybindings TUI**: Keyb - **Keybindings TUI**: Keyb ([Config](../.config/keyb/))
#### GUI Apps </details>
- **Music Player**: Spotify (patched with Spicetify) <details>
- **Web Browser**: Librewolf / Thorium <summary><b>🖱️ GUI Apps</b></summary>
- **Messaging App**: Discord (patched with BetterDiscord)
- **Music Player**: Spotify (patched with Spicetify) ([Config](../.config/spicetify/))
- **Web Browser**: Librewolf / Thorium ([Config](../.config/librewolf/))
- **Messaging App**: Discord (patched with BetterDiscord) ([Config](../.config/BetterDiscord/))
- **Email Client**: Thunderbird - **Email Client**: Thunderbird
- **PDF Viewer**: Zathura - **PDF Viewer**: Zathura ([Config](../.config/zathura/))
- **Note Taking**: Obsidian - **Note Taking**: Obsidian
- **Video Player**: Celluloid (MPV) - **Video Player**: Celluloid (MPV)
- **Image Viewer**: geeqie - **Image Viewer**: geeqie
@ -86,13 +93,18 @@ Here is some _small_ information about my setup:
- **Recording Program**: OBS - **Recording Program**: OBS
- **Office Apps**: LibreOffice - **Office Apps**: LibreOffice
#### Other </details>
- **Colorscheme**: Catppuccin <details>
<summary><b>🔍 Other</b></summary>
- **Colorscheme**: Catppuccin Macchiato
- **Font**: Jetbrains Mono Nerd - **Font**: Jetbrains Mono Nerd
- **Dotfiles Manager**: yadm - **Dotfiles Manager**: yadm ([Config](../.config/yadm/))
- **Automatic System Deployment**: Ansible - **Automatic System Deployment**: Ansible
</details>
## :wrench: <samp>[Setup](#setup)</samp> ## :wrench: <samp>[Setup](#setup)</samp>
#### :package: <samp>Automatic Installation (Arch Linux)</samp> #### :package: <samp>Automatic Installation (Arch Linux)</samp>

BIN
.github/assets/images/dotfiles-binds.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB