Dotfiles are configuration files that are used to customize and personalize your system. The dotfiles name comes from the UNIX convention of prefixing config files with a dot. By default, these files are usually hidden in directory listings.
This repo contains my very own dotfiles, please feel free to use anything and
everything -- at your own risk
Note: the installer script will attempt to install the following hard requirements 👇
- gnu stow (symlink manager) - avoid having to manually create sym links
- homebrew - missing package manager (will install on MacOS only, don't worry)
Please see the Install section, directly below, for more information!
To install with Git:
git clone https://github.com/vinnyA3/dotfiles.git ~/.dotfiles &&
source ~/.dotfiles/install.sh
The installer script will attempt to install GNU's Stow & the Homebrew package manager (on MacOS). Interestingly enough, homebrew works with linux as well; however, I choose to use the distro's package manager for the most part (I'll opt to use Nix package manager) when the default pkg manager does not have the latest pkg version when I need it). The installer will try to detect your linux distro; specifically, it will try detect your distro's default package manager. Right now, the supported linux package managers are:
- PopOS's & Ubuntu's
apt
- Void Linux's
xbps
Feel free to add other package managers to the script!
- Current OS(s): PopOS, MacOS -- work machine
- window manager(s): PopOS's tiling manager, xmonad
- statusbar(s): polybar - default, xmobar
- theme: Catppuccin
- editor: Neovim -- check out my Neovim config files here
- shell: zsh - default, Bash
- terminal emulator(s): Alacritty - default, ST (Suckless term)
- programs & binaries(installed separately): fzf, rg, ag, node (managed by nvm)
- many, if not all of these programs are utilized by my Vim setup
⚠️ while the legacy vim config lives here, the main neovim configuration exists in separate repo: https://github.com/vinnyA3/neovim-config
The core configuration of my development env (zsh, tmux, vim/neovim, helper scripts) try their best to be OS agnostic; however, there are certain instances where you just can't get around configuration for the specific platform that you're working with. For those cases, the lines are commented in/out in the various config files.
Screenshots
-
Get started with your own dotfiles
Lars Kappart has a great article on dotfiles and how to get them set up. I used some of Lar's setup scripts to help with some scaffolding.