kayprish/dotfiles
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
dotfiles/.github/README.md

184 lines
11 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div align="center">
<a href="#"><img src="./assets/images/dotfiles-title.png"></a>
</div>
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/palette/macchiato.png"/><br>
<div align="center">
<a href="#herb--about"><img width="190px" src="./assets/images/dotfiles-about.png"></a>
<a href="#wrench--setup"><img width="190px" src="./assets/images/dotfiles-setup.png"></a>
<a href="#camera--gallery"><img width="190px" src="./assets/images/dotfiles-gallery.png"></a>
<a href="#tada--credits"><img width="190px" src="./assets/images/dotfiles-credits.png"></a>
</div>
<div align="center">
<img src="./assets/images/big-showcase.png">
</div>
<br>
<div align="center">
<a href="https://github.com/Matt-FTW/dotfiles/stargazers"><img alt="Stargazers" src="https://img.shields.io/github/stars/Matt-FTW/dotfiles?style=for-the-badge&logo=starship&color=C9CBFF&logoColor=D9E0EE&labelColor=302D41"></a>
<a href="https://github.com/Matt-FTW/dotfiles/issues"><img alt="Forks" src="https://img.shields.io/github/issues/Matt-FTW/dotfiles?style=for-the-badge&logo=gitbook&color=B5E8E0&logoColor=D9E0EE&labelColor=302D41"></a>
<a href="https://github.com/Matt-FTW/dotfiles/commits/main/"><img alt="Commit Activity" src="https://img.shields.io/github/commit-activity/m/Matt-FTW/dotfiles/main?style=for-the-badge&logo=github&color=F2CDCD&logoColor=D9E0EE&labelColor=302D41"/></a>
<a href="https://github.com/Matt-FTW/dotfiles"><img alt="Size" src="https://img.shields.io/github/repo-size/Matt-FTW/dotfiles?style=for-the-badge&logo=discord&color=DDB6F2&logoColor=D9E0EE&labelColor=302D41"></a>
</div>
## :herb: ‎ <samp>About</samp>
Hey there! :wave:
This is my personal repository for my Dotfiles.
I've been working on this for a long time so I hope you like it!
This repo is always changing, so I may add new stuff in the future. If you encounter some issues or if you have any ideas to improve the setup, make sure to report them in the issue tracker over here at Github.
---
Here is some _small_ information about my setup:
> ℹ️ INFO: Some of this apps have the config included in the repo, which are marked with ⚙️), and others don't because simply they don't have any or is not worth saving it because of their defaults. Also, my favorite are programs and tools are marked with ✨.
<details>
<summary><b>🐧 System</b></summary>
- **OS**: [Arch Linux](https://archlinux.org/) :sparkles: ([btw](https://www.reddit.com/r/archlinux/comments/6hv94x/has_anyone_seen_arch/))
- **Package Manager**: [Pacman](https://wiki.archlinux.org/title/Pacman) _([:gear: Conf](../.config/pacman/))_
- **AUR Helper**: [yay](https://github.com/Jguer/yay) :sparkles: _([:gear: Conf](../.config/yay/))_
- **Window Manager**: [Hyprland](https://hyprland.org/) :sparkles: _([:gear: Conf](../.config/hypr/))_
- **Panel**: [Waybar](https://github.com/Alexays/Waybar) :sparkles: _([:gear: Conf](../.config/waybar/))_
- **Terminal Emulator**: [Kitty](https://sw.kovidgoyal.net/kitty/) :sparkles: _([:gear: Conf](../.config/kitty/))_
- **Notification Daemon/Center**: [swaync](https://github.com/ErikReider/SwayNotificationCenter) _([:gear: Conf](../.config/swaync/))_
- **Application Launcher**: [Rofi](https://github.com/lbonn/rofi) :sparkles: _([:gear: Conf](../.config/rofi/))_
- **Audio Daemon**: [Pipewire](https://pipewire.org/) _([:gear: Conf](../.config/pipewire/))_
- **Firewall**: [ufw](https://wiki.archlinux.org/title/ufw)
- **Clipboard Manager**: [wl-clipboard](https://github.com/bugaevc/wl-clipboard) (with [cliphist](https://github.com/sentriz/cliphist))
- **Wallpaper Switcher**: [swww](https://github.com/Horus645/swww)
- **Lock Screen**: [swaylock-effects](https://github.com/jirutka/swaylock-effects) _([:gear: Conf](../.config/swaylock/))_
- **Idle Timeout**: [swayidle](https://github.com/swaywm/swayidle) _([:gear: Conf](../.config/swayidle/))_
- **Color Picker**: [Hyprpicker](https://github.com/hyprwm/hyprpicker)
- **Recording Tool**: [wf-recorder](https://github.com/ammen99/wf-recorder)
- **Screenshot Tool**: [Hyprshot](https://github.com/Gustash/Hyprshot)
- **Screenshot Editor**: [Swappy](https://github.com/jtheoof/swappy) _([:gear: Conf](../.config/swappy/))_
- **Logout Menu**: [wleave](https://github.com/AMNatty/wleave) _([:gear: Conf](../.config/wleave/))_
</details>
<details>
<summary><b>🖥️ CLI/TUI Apps</b></summary>
- **Shell**: [Fish](https://fishshell.com/) :sparkles: _([:gear: Conf](../.config/fish/))_
- **Shell Prompt**: [Starship](https://starship.rs/) _([:gear: Conf](../.config/starship/))_
- **Shell History**: [Atuin](https://github.com/atuinsh/atuin) _([:gear: Conf](../.config/atuin/))_
- **CD Replacement**: [zoxide](https://github.com/ajeetdsouza/zoxide) :sparkles:
- **LS Replacement**: [eza](https://github.com/eza-community/eza)
- **Cat Replacement**: [bat](https://github.com/sharkdp/bat) _([:gear: Conf](../.config/bat/))_
- **Find Replacement**: [fd](https://github.com/sharkdp/fd) _([:gear: Conf](../.config/fd/))_
- **Help Pages**: [Navi](https://github.com/denisidoro/navi) / [TLDR](https://tldr.sh/) _([:gear: Conf](../.config/navi/))_
- **Fuzzy File Finder**: [fzf](https://github.com/junegunn/fzf) :sparkles:
- **Fuzzy Word Finder**: [Ripgrep](https://github.com/BurntSushi/ripgrep) _([:gear: Conf](../.config/rg/))_
- **Editor**: [Neovim](https://neovim.io/) :sparkles: _([:gear: Conf](../.config/nvim/))_
- **File Manager**: [Yazi](https://yazi-rs.github.io/) :sparkles: _([:gear: Conf](../.config/yazi/))_
- **Git UI**: [Lazygit](https://github.com/jesseduffield/lazygit) :sparkles: _([:gear: Conf](../.config/lazygit/))_
- **Npm Manager UI**: [Lazynpm](https://github.com/jesseduffield/lazynpm)
- **Docker UI**: [Lazydocker](https://github.com/jesseduffield/lazydocker)
- **Arch Package Search UI**: [Pacseek](https://github.com/moson-mo/pacseek) _([:gear: Conf](../.config/pacseek/))_
- **Update Tool**: [Topgrade](https://github.com/topgrade-rs/topgrade) _([:gear: Conf](../.config/topgrade/))_
- **Audio Visualizer**: [Cava](https://github.com/karlstav/cava) _([:gear: Conf](../.config/cava/))_
- **System Monitor**: [btop](https://github.com/aristocratos/btop) _([:gear: Conf](../.config/btop/))_
- **GPU Monitor**: [nvtop](https://github.com/Syllo/nvtop)
- **System Fetch**: [Neofetch](https://github.com/dylanaraps/neofetch) _([:gear: Conf](../.config/neofetch/))_
- **Git Fetch**: [Onefetch](https://github.com/o2sh/onefetch)
- **Keybindings TUI**: [Keyb](https://github.com/kencx/keyb) :sparkles: _([:gear: Conf](../.config/keyb/))_
</details>
<details>
<summary><b>🖱️ GUI Apps</b></summary>
- **Music Player**: [Spotify](https://open.spotify.com/) (patched with [Spicetify](https://spicetify.app/)) _([:gear: Conf](../.config/spicetify/))_
- **Web Browser**: [Librewolf](https://librewolf.net/) :sparkles: _([:gear: Conf](../.config/browser/))_
- **Messaging App**: [Discord](https://discord.com/) (patched with [BetterDiscord](https://betterdiscord.app/)) _([:gear: Conf](../.config/BetterDiscord/))_
- **Email Client**: [Thunderbird](https://www.thunderbird.net/)
- **PDF Viewer**: [Zathura](https://pwmt.org/projects/zathura/) _([:gear: Conf](../.config/zathura/))_
- **Note Taking App**: [Obsidian](https://obsidian.md/) :sparkles:
- **Video Player**: [Celluloid](https://celluloid-player.github.io/) ([MPV](https://mpv.io/) frontend) _([:gear: Conf](../.config/mpv/))_
- **Image Viewer**: [geeqie](https://www.geeqie.org/) _([:gear: Conf](../.config/geeqie/))_
- **File Manager**: [Nemo](https://community.linuxmint.com/software/view/nemo)
- **Audio Effects**: [Easyeffects](https://github.com/wwmm/easyeffects)
- **Image Editor**: [Krita](https://krita.org/)
- **Paint Tool**: [Pinta](https://www.pinta-project.com/)
- **VM Manager**: [Virt-Manager](https://virt-manager.org/) ([QEMU](https://www.qemu.org/))
- **Recording Program**: [OBS](https://obsproject.com/)
- **Office Apps**: [LibreOffice](https://www.libreoffice.org/) _([:gear: Conf](../.config/libreoffice/4/user/config/))_
</details>
<details>
<summary><b>🔍 Other</b></summary>
- **Colorscheme**: [Catppuccin Macchiato](https://github.com/catppuccin/catppuccin) :sparkles:
- **Font**: [JetBrainsMono Nerd Font](https://www.jetbrains.com/es-es/lp/mono/)
- **Dotfiles Manager**: [yadm](https://yadm.io/) :sparkles: _([:gear: Conf](../.config/yadm/))_
- **Automatic System Deployment**: [Ansible](https://www.ansible.com/) :sparkles: _([:gear: Conf](../.config/ansible/))_
</details>
## :wrench: ‎ <samp>Setup</samp>
#### :package: <samp>Automatic Installation (Arch Linux)</samp>
> :warning: WARNING: This installation is specifically designed for Arch Linux. If you're running other systems, install the packages with your OS's package manager.
##### WIP
#### :package: <samp>Manual Installation (Universal) </samp>
> :information_source: INFO: This installation assumes you have the **.config dir** in your home dir. Also, note that the names of the packages are from the AUR and Arch Repos. Adapt them to your system.
##### WIP
## :camera: ‎ <samp>Gallery</samp>
![overview-1](./assets/images/overview-1.png)
![overview-2](./assets/images/overview-2.png)
![overview-3](./assets/images/overview-3.png)
![overview-4](./assets/images/overview-4.png)
![overview-5](./assets/images/overview-5.png)
![overview-6](./assets/images/overview-6.png)
![overview-7](./assets/images/overview-7.png)
![overview-8](./assets/images/overview-8.png)
![overview-9](./assets/images/overview-9.png)
> :information_source: For specific images and videos about each tool, check out their own READMEs at their respective config folders. (STILL WIP 🚧)
## :tada: ‎ <samp>Credits</samp>
Big thanks to everyone at r/unixporn for inspiring me to make this!
I wanna point out some resources that helped me the most with the setup:
- [ArchWiki](https://wiki.archlinux.org/) for all the awesome documentation.
- [Folke](https://github.com/folke) for his amazing contributions to the Neovim community with some awesome plugins and with the distro that i use: **LazyVim**. Also, his READMEs and [dotfiles](https://github.com/folke/dot) are amazing!
- [Yoru's README](https://github.com/rxyhn/yoru/tree/main) to help me with the distribution of the README
- [Amadeus Dots](https://github.com/AmadeusWM/dotfiles-hyprland) for helping me with the startup setup of the Hyprland WM.
- [Catppuccin](https://github.com/catppuccin/catppuccin) for making the **Best Colorscheme Ever** 🖌️
Those were the biggest inspiring factor for me, though you can find a lot more of setups that helped me in my List of Dotfiles from the **Stars** section of my Github Profile: [Check it out!](https://github.com/stars/Matt-FTW/lists/paintbrush-theming-dots)
## :star: ‎ <samp>Star History</samp>
Thanks to everyone who gave a star to this project! ❤️
<a href="https://star-history.com/#Matt-FTW/dotfiles&Timeline">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Matt-FTW/dotfiles&type=Timeline&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Matt-FTW/dotfiles&type=Timeline" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Matt-FTW/dotfiles&type=Timeline" />
</picture>
</a>
Reference in a new issue View git blame Copy permalink