Dotfiles

Welcome to my personal dotfiles repository! This collection of configuration files and scripts helps me maintain a consistent and productive development environment across different machines.

🚀 Quick Start

git clone https://github.com/nkululekojonas/dotfiles.git
cd dotfiles
./install.sh

This will create a .config directory in your home directory if one doesn't already exit, this is where all config files will be stored.

📦 Some of What's Inside

• .zshrc: ZSH shell configuration
• .vimrc: Vim editor settings
• .tmux.conf: Tmux terminal multiplexer configuration
• .gitconfig: Git version control preferences
• Brewfile: List of packages to install via Homebrew

This includes some custom functions and personal aliases located in zsh/.

🛠 Installation

1. Clone this repository to your home directory:

   git clone https://github.com/nkululekojonas/dotfiles.git ~/dotfiles
   

2. Run the installation script:

   cd ~/dotfiles
   ./install.sh
   

The install script will symlink the appropriate files to your home directory. Make sure to back up your existing dotfiles before running the script.

🛠 Dry Run

1. Run the installing script with --dry-run flag

   cd ~/dotfiles
   ./install.sh --dry-run
   

   Output will be what would have changed

⚙️ Customization

Feel free to modify these dotfiles to suit your preferences. The main configuration files are:

• zsh/zshrc for ZSH settings
• tmux/tmux.conf for Tmux configuration
• vim/vimrc for Vim configuration
• git/gitconfig for Git setup

After making changes, run ./install.sh again to update the symlinks.

📚 What I Use

• Shell: ZSH with Oh My Zsh
• Terminal: iTerm2
• Editor: Vim / Zed + Visual Studio Code
• Version Control: Git
• Package Manager: Homebrew

🤝 Contributing

While these dotfiles are personalized for my use, I'm open to suggestions and improvements! This is an ever changing repo of my personal preferances but feel free to fork this repository, make changes, and submit a pull request.

📄 License

This project is open source and available under the MIT License.

🙏 Acknowledgments

• Inspired by Mathias Bynens' dotfiles
• Thanks to the dotfiles community for inspiration and ideas

---