Welcome to my personal dotfiles repository. This repository contains configuration files and scripts to set up my development environment across different machines using GNU Stow.
- Introduction
- Prerequisites
- Installation
- Available Configurations
- Usage
- Customization
- Contributing
- License
Dotfiles are plain text configuration files on Unix-y systems for customizing system and application behavior. This repository includes my configurations for various tools and applications, managed using GNU Stow.
Before you begin, ensure you have GNU Stow installed on your system. You can install it using your package manager:
- On Ubuntu/Debian:
sudo apt-get install stow
- On macOS (using Homebrew):
brew install stow
To set up these dotfiles on your system, follow these steps:
-
Clone the repository:
git clone https://github.com/rsoutar/dotfiles.git ~/.dotfiles cd ~/.dotfiles
-
Use Stow to symlink the configurations:
To install all configurations at once, use:
stow .
This command will stow everything in the current directory.
Alternatively, if you want to install specific configurations, you can use:
stow [package_name]
Replace
[package_name]
with the name of the configuration you want to install (e.g.,vim
,zsh
,git
).
This repository includes configurations for:
- Shell (Bash/Zsh)
- Vim/Neovim
- Git
- Tmux
- [List any other tools or applications you have configurations for]
Each configuration is organized in its own directory within the repository.
After installation, the configurations will be symlinked to your home directory. You can start using your customized environment right away.
For example:
- Open your terminal to see the shell configuration.
- Open Vim/Neovim to see the editor configuration.
- Use Git to see the Git configuration.
You can customize these dotfiles to suit your preferences:
- Navigate to the appropriate directory in the repository (e.g.,
~/.dotfiles/vim/
for Vim configurations). - Edit the configuration files as needed.
- The changes will be reflected immediately due to the symlinks created by Stow.
Feel free to explore and modify the files in this repository to better fit your workflow.
If you have suggestions or improvements, feel free to open an issue or submit a pull request. Contributions are welcome!
This repository is licensed under the MIT License. See the LICENSE file for more details.