Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: #228 and # 219 implemented. #230

Merged
merged 1 commit into from
Oct 7, 2024
Merged

docs: #228 and # 219 implemented. #230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 99 additions & 81 deletions .github/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Dotfiles
# :hammer_and_wrench: Dotfiles

## :wave: Greetings

Greetings. Thanks for stopping by. This repository is the repository of my Linux
desktop system configuration. I tried to make my system lightweight, fast, easy
Expand All @@ -8,18 +10,33 @@ tried to configure all programs in the same color palette.

![samples](assets/final.png "Gallery")

## Table of Contents

- [Core system info](#core-system-info)
- [Whole System Info](#whole-system-info)
- [Main system software](#main-system-software)
- [Shell and CLI/TUI software](#shell-and-clitui-software)
- [GUI software](#gui-software)
- [Appearance](#appearance)
- [Dotfiles installation](#dotfiles-installation)
- [Acknowledgements and some additional info](#acknowledgements-and-some-additional-info)

## Core system info
## :bookmark_tabs: Table of Contents

- [Main features](#stars-main-features)
- [Core system info](#brain-core-system-info)
- [Whole System Info](#computer-whole-system-info)
- [Main system software](#brain-main-system-software)
- [Shell and CLI/TUI software](#shell-shell-and-clitui-software)
- [GUI software](#window-gui-software)
- [Appearance](#paintbrush-appearance)
- [Dotfiles installation](#rocket-dotfiles-installation)
- [Acknowledgements and some additional info](#heart-acknowledgements-and-some-additional-info)

## :stars: Main features

- :dark_sunglasses: Gruvbox-material for the whole system.
- :wrench: Modular configuration.
- :keyboard: Keyboard orientation.
- :window: SwayWM.
- :heart_eyes: Beautiful wallpapers.
- :floppy_disk: TUI where it possible.
- :bell: Notification Center.
- :sound: Volume and brightness OSD.
- :lock: Idle and lock apps.
- :gear: Custom scripts and hooks for automation.
- Various other tweaks...

## :brain: Core system info

- OS: [Arch Linux](https://archlinux.org/)
- WM: [Sway](https://github.com/swaywm/sway/)
Expand All @@ -33,79 +50,80 @@ tried to configure all programs in the same color palette.
- Notification Manager: [swaync](https://github.com/ErikReider/SwayNotificationCenter/)
- Colorscheme: [Gruvbox-material](https://github.com/sainnhe/gruvbox-material/)

## Whole system info
## :computer: Whole system info
<!-- markdownlint-disable MD013 -->
All the info about my setup.

> Some of this apps have the config files included in the repo, which are
marked with :gear:. If you need some information about a program/script etc,
just go to its directory, README will help you.

### Main system software

| Entry | App |
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------- |
| **OS** | [Arch Linux](https://archlinux.org/) |
| **AUR helper** | [paru](https://github.com/Morganamilo/paru/) [:gear:](../.config/paru/) |
| **Display manager** | [greetd](https://sr.ht/~kennylevinsen/greetd/) (with [tuigreet](https://github.com/apognu/tuigreet/)) |
| **Window manager** | [SwayWM](https://github.com/swaywm/sway/) [:gear:](../.config/sway/) |
| **Notification daemon** | [swaync](https://github.com/ErikReider/SwayNotificationCenter/) [:gear:](../.config/swaync/) |
| **Popup daemon** | [swayosd](https://github.com/ErikReider/SwayOSD/) |
| **Bar** | [waybar](https://github.com/Alexays/Waybar/) [:gear:](../.config/waybar/) |
| **Audio daemon** | [pipewire](https://github.com/PipeWire/pipewire/) |
| **Application launcher** | [rofi](https://github.com/lbonn/rofi/) [:gear:](../.config/rofi/) |
| **Clipboard manager** | [wl-clipboard](https://github.com/bugaevc/wl-clipboard/) (with [cliphist](https://github.com/sentriz/cliphist/)) |
| **Lock screen** | [swaylock](https://github.com/jirutka/swaylock-effects/) [:gear:](../.config/swaylock/) |
| **Idle timeout** | [swayidle](https://github.com/hyprwm/hypridle/) [:gear:](../.config/swayidle/) |
| **Screenshot tool** | [swappy](https://github.com/jtheoof/swappy/) (with [grim](https://sr.ht/~emersion/grim/)) |

### Shell and CLI/TUI software

| Entry | App |
| --------------------------- | ----------------------------------------------------------------------------------------------- |
| **Shell** | [zsh](https://github.com/zsh-users/zsh/) [:gear:](../.zshrc) |
| **Shell configuration** | [ohmyzsh](https://github.com/ohmyzsh/ohmyzsh/) |
| **Terminal emulator** | [kitty](https://sw.kovidgoyal.net/kitty/) [:gear:](../.config/kitty/) |
| **Text editor** | [neovim](https://neovim.io/) [:gear:](../.config/nvim/) |
| **System information** | [neofetch](https://github.com/dylanaraps/neofetch/) [:gear:](../.config/neofetch/) |
| **ls replacement** | [eza](https://github.com/eza-community/eza/) |
| **cat Replacement** | [bat](https://github.com/sharkdp/bat/) [:gear:](../.config/bat/) |
| **find replacement** | [fd](https://github.com/sharkdp/fd/) |
| **File manager** | [yazi](https://github.com/sxyazi/yazi/) [:gear:](../.config/yazi/) |
| **Fuzzy file finder** | [fzf](https://github.com/junegunn/fzf/) |
| **Fuzzy word finder** | [ripgrep](https://github.com/BurntSushi/ripgrep/) |
| **Git TUI** | [lazygit](https://github.com/jesseduffield/lazygit/) |
| **Docker TUI** | [lazydocker](https://github.com/jesseduffield/lazydocker/) |
| **Trash CLI** | [glib2](https://archlinux.org/packages/core/x86_64/glib2) (gio trash) |
| **System monitor** | [btop](https://github.com/aristocratos/btop/) [:gear:](../.config/btop/) |
| **Pulse audio control** | [pulsemixer](https://github.com/GeorgeFilipkin/pulsemixer/) [:gear:](../.config/pulsemixer.cfg) |

### GUI software

| Entry | App |
| ------------------------ | ------------------------------------------------------------------------------------- |
| **Web browser** | [Firefox developer edition](https://www.mozilla.org/en-US/firefox/developer/) |
| **Messaging app** | [Vesktop](https://github.com/Vencord/Vesktop/) (Discord Client) |
| **PDF viewer** | [Zathura](https://github.com/pwmt/zathura/) [:gear:](../.config/zathura/) |
| **Note taking app** | [Obsidian](https://obsidian.md/) |
| **Video player** | [MPV](https://github.com/mpv-player/mpv/) [:gear:](../.config/mpv/) |
| **Image viewer** | [imv](https://github.com/eXeC64/imv/) [:gear:](../.config/imv/) |
| **Audio effects** | [Easyeffects](https://github.com/wwmm/easyeffects/) [:gear:](../.config/easyeffects/) |
| **Image editor** | [Krita](https://krita.org/) |
| **Office apps** | [LibreOffice](https://www.libreoffice.org/) |
| **Password manager** | [KeePassXC](https://github.com/keepassxreboot/keepassxc/) |

### Appearance

| Entry | App |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| **Colorscheme** | [Gruvbox-material](https://github.com/sainnhe/gruvbox-material/) (material soft) |
| **Fonts** | [JetBrainsMono](https://www.jetbrains.com/es-es/lp/mono/) and [Hack](https://github.com/source-foundry/Hack/) |
| **Icon theme** | [Gruvbox-Material-Dark](https://github.com/TheGreatMcPain/gruvbox-material-gtk/) |
| **Cursor theme** | [Gruvbox Dark](https://gitlab.com/cursors/simp1e/) |
| **Wallpappers** | [Aenami's](https://www.instagram.com/aenami.art/) art works [:gear:](../.wallpaper/) |

## Dotfiles installation
### :brain: Main system software

| Entry | App |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| **OS** | [Arch Linux](https://archlinux.org/) |
| **AUR helper** | [paru](https://github.com/Morganamilo/paru/) [:gear:](../.config/paru/) |
| **Display manager** | [greetd](https://sr.ht/~kennylevinsen/greetd/) (with [tuigreet](https://github.com/apognu/tuigreet/) [:gear:](../.system-config-backup/greetd/)) |
| **Window manager** | [SwayWM](https://github.com/swaywm/sway/) [:gear:](../.config/sway/) |
| **Notification daemon** | [swaync](https://github.com/ErikReider/SwayNotificationCenter/) [:gear:](../.config/swaync/) |
| **Popup daemon** | [swayosd](https://github.com/ErikReider/SwayOSD/) |
| **Bar** | [waybar](https://github.com/Alexays/Waybar/) [:gear:](../.config/waybar/) |
| **Audio daemon** | [pipewire](https://github.com/PipeWire/pipewire/) |
| **Application launcher** | [rofi](https://github.com/lbonn/rofi/) [:gear:](../.config/rofi/) |
| **Clipboard manager** | [wl-clipboard](https://github.com/bugaevc/wl-clipboard/) (with [cliphist](https://github.com/sentriz/cliphist/)) |
| **Lock screen** | [swaylock](https://github.com/jirutka/swaylock-effects/) [:gear:](../.config/swaylock/) |
| **Idle timeout** | [swayidle](https://github.com/hyprwm/hypridle/) [:gear:](../.config/swayidle/) |
| **Screenshot tool** | [swappy](https://github.com/jtheoof/swappy/) [:gear:](../.config/swayidle/) (with [grim](https://sr.ht/~emersion/grim/)) |

### :shell: Shell and CLI/TUI software

| Entry | App |
| ----------------------- | ----------------------------------------------------------------------------------------------- |
| **Shell** | [zsh](https://github.com/zsh-users/zsh/) [:gear:](../.zshrc) |
| **Shell configuration** | [ohmyzsh](https://github.com/ohmyzsh/ohmyzsh/) |
| **Terminal emulator** | [kitty](https://sw.kovidgoyal.net/kitty/) [:gear:](../.config/kitty/) |
| **Text editor** | [neovim](https://neovim.io/) [:gear:](../.config/nvim/) |
| **System information** | [neofetch](https://github.com/dylanaraps/neofetch/) [:gear:](../.config/neofetch/) |
| **ls replacement** | [eza](https://github.com/eza-community/eza/) |
| **cat Replacement** | [bat](https://github.com/sharkdp/bat/) [:gear:](../.config/bat/) |
| **find replacement** | [fd](https://github.com/sharkdp/fd/) |
| **cp/mv replacement** | [advcpmv](https://github.com/jarun/advcpmv) |
| **File manager** | [yazi](https://github.com/sxyazi/yazi/) [:gear:](../.config/yazi/) |
| **Fuzzy file finder** | [fzf](https://github.com/junegunn/fzf/) |
| **Fuzzy word finder** | [ripgrep](https://github.com/BurntSushi/ripgrep/) |
| **Git TUI** | [lazygit](https://github.com/jesseduffield/lazygit/) |
| **Docker TUI** | [lazydocker](https://github.com/jesseduffield/lazydocker/) |
| **Trash CLI** | [glib2](https://archlinux.org/packages/core/x86_64/glib2) (gio trash) |
| **System monitor** | [btop](https://github.com/aristocratos/btop/) [:gear:](../.config/btop/) |
| **Pulse audio control** | [pulsemixer](https://github.com/GeorgeFilipkin/pulsemixer/) [:gear:](../.config/pulsemixer.cfg) |

### :window: GUI software

| Entry | App |
| -------------------- | ------------------------------------------------------------------------------------- |
| **Web browser** | [Firefox developer edition](https://www.mozilla.org/en-US/firefox/developer/) |
| **Messaging app** | [Vesktop](https://github.com/Vencord/Vesktop/) (Discord Client) |
| **PDF viewer** | [Zathura](https://github.com/pwmt/zathura/) [:gear:](../.config/zathura/) |
| **Note taking app** | [Obsidian](https://obsidian.md/) |
| **Video player** | [MPV](https://github.com/mpv-player/mpv/) [:gear:](../.config/mpv/) |
| **Image viewer** | [imv](https://github.com/eXeC64/imv/) [:gear:](../.config/imv/) |
| **Audio effects** | [Easyeffects](https://github.com/wwmm/easyeffects/) [:gear:](../.config/easyeffects/) |
| **Image editor** | [Krita](https://krita.org/) |
| **Office apps** | [LibreOffice](https://www.libreoffice.org/) |
| **Password manager** | [KeePassXC](https://github.com/keepassxreboot/keepassxc/) |

### :paintbrush: Appearance

| Entry | App |
| ---------------- | ------------------------------------------------------------------------------------------------------------- |
| **Colorscheme** | [Gruvbox-material](https://github.com/sainnhe/gruvbox-material/) (material soft) |
| **Fonts** | [JetBrainsMono](https://www.jetbrains.com/es-es/lp/mono/) and [Hack](https://github.com/source-foundry/Hack/) |
| **Icon theme** | [Gruvbox-Material-Dark](https://github.com/TheGreatMcPain/gruvbox-material-gtk/) |
| **Cursor theme** | [Gruvbox Dark](https://gitlab.com/cursors/simp1e/) |
| **Wallpappers** | [Aenami's](https://www.instagram.com/aenami.art/) art works [:gear:](../.wallpaper/) |

## :rocket: Dotfiles installation

If you want to install my dotfiles, here are some tips and recommendations.

Expand All @@ -124,7 +142,7 @@ If you want to install my dotfiles, here are some tips and recommendations.
If you still have any questions, please feel free to ask them in the
[discussions](https://github.com/CelticBoozer/dotfiles/discussions/).

## Acknowledgements and some additional info
## :heart: Acknowledgements and some additional info

I would like to thank the entire community, anyone who uses or is inspired by
my dotfiles. To everyone who inspired or helped me (I tried to indicate each
Expand All @@ -133,6 +151,6 @@ author in each script or file I borrowed fully or partially).
If you like this project and want to express your gratitude - star this
repository. Or you can donate.

### Star history
### :star: Star history

[![Star History Chart](https://api.star-history.com/svg?repos=CelticBoozer/dotfiles&type=Timeline&theme=dark)](https://star-history.com/#CelticBoozer/dotfiles&Timeline)
1 change: 1 addition & 0 deletions .zshrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,4 @@ alias l="eza --long --header --git --icons=always --all"
alias cp="cpg -g"
alias mv="mvg -g"
alias cat="bat"
alias find="fd"
Loading