This guide provides instructions on setting up your development environment using my dotfiles repository.
This repository contains configuration files for the following tools:
- nvim (Neovim) - A modern and highly customizable text editor for coding.
- aerospace - Configuration for the Aerospace tool (or a custom tool).
- raycast - Settings for Raycast, the productivity app for macOS.
Before you start, ensure that Homebrew is installed on your system. Homebrew is a package manager for macOS and Linux that allows you to easily install software and manage dependencies.
- If you don’t have Homebrew installed, run the following command to install it:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
- Clone the dotfiles repository to your machine:
git clone https://github.com/yourusername/dotfiles.git ~/.dotfiles
- Navigate to the dotfiles directory and install the required applications via Homebrew by running the following command:
brew bundle --file= ~/.dotfiles/brew/Brewfile
This will install the apps listed in the Brewfile
(such as Neovim, Raycast, and Aerospace, if applicable).
After cloning the repository and installing the necessary software, you need to create symlinks for the configuration files. This step ensures that your system uses the dotfiles from the repository rather than the default configuration files.
To create the symlinks, use the following commands:
# Link the .zshrc file for Zsh configuration and Secret Variables
ln -s ~/.dotfiles/zsh/zshrc ~/.zshrc
ln -s ~/.dotfiles/zsh/zprofile ~/.zprofile
ln -s ~/.dotfiles/zsh/private ~/.private
# Link the .tmux.conf file for tmux configuration
ln -s ~/.dotfiles/tmux/tmux.conf ~/.tmux.conf
# Link the .p10k.zsh file for Powerlevel10k prompt configuration
ln -s ~/.dotfiles/p10k/p10k.zsh ~/.p10k.zsh
# Link the aerospace configuration folder
ln -s ~/.dotfiles/aerospace ~/.config/aerospace
# Link the Neovim configuration folder
ln -s ~/.dotfiles/nvim ~/.config/nvim
# Link to Git essentials
ln -s ~/.dotfiles/git/gitconfig ~/.gitconfig
ln -s ~/.dotfiles/git/gitconfig ~/.gitconfig
ln -s ~/.dotfiles/git/hooks/post-commit .git/hooks // should run in ~/.dotfiles directory
ln -s ~/.dotfiles/git/hooks/pre-commit .git/hooks // should run in ~/.dotfiles directory
These symlinks ensure that your system uses the custom configuration files from this repository.