Skip to content

colepeters/dotfiles

Repository files navigation

dotfiles

Configurations and optimisations for Zsh, Git, Neovim, etc.

These dotfiles have been created for my own use and I make no assurances of them working for anyone else. That said, I like sharing these things in the open for others to borrow from, so please make use of these as you like.

Usage (macOS)

These instructions have been tested on my own machine (macOS 13, using the latest version of iTerm2). They presume that you do not already have a .dotfiles/ directory in your user (~/) directory.

Prerequisites

  1. Install Homebrew
  2. Install NodeJS
  3. Install Neovim
  4. Install ripgrep for use with Telescope.nvim: brew install ripgrep

Install

# Install ZSH via Homebrew (usually more up to date that macOS default)
brew install zsh

# Add zsh to standard shells
sudo vi /etc/shells              # 👈 Add /opt/homebrew/bin/zsh at the end of this file

# Switch into Zsh
chsh -s /opt/homebrew/bin/zsh

# Clone the repo to into a ".dotfiles" directory in your user directory
git clone git@github.com:colepeters/dotfiles.git ~/.dotfiles

# Switch to the new directory
cd ~/.dotfiles

# Initialise and update Zgen
git submodule init && git submodule update

# Install RCM
brew tap thoughtbot/formulae
brew install rcm

# Copy the RCM config file to your ~ directory first
rcup -v rcrc

# Generate symlinked dotfiles in your ~ directory
rcup -v

Additional packages

Some aliases and configurations depend on these packages to work:

# Tig, a Git CLI wrapper:
brew install tig

# Eza, a nicer `ls`
brew install eza

# diff-so-fancy, for better git diffs:
npm i -g diff-so-fancy

# HTTPie, a nice cURL replacement:
brew install httpie

🎉 Ta-da

You should now be able to open a new shell session and have everything be not horrible and hopefully cooler and ready to go.

Credits

Managed with rcm by Thoughtbot, which is an awesome, lightweight tool for keeping dotfiles synced and organised.

A ton of my Neovim setup was sourced from LunarVim, via an excellent YouTue playlist.

Some Zsh and Git configurations have been borrowed from the YADR dotfiles repository.