Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mxsaad/dotfiles

dots for macOS
https://github.com/mxsaad/dotfiles

dotfiles macos stow

Last synced: 15 days ago
JSON representation

dots for macOS

Awesome Lists containing this project

README

        

# Dotfiles

This repository contains my dotfiles, which are configuration files for various programs and tools that I use on my system. I manage these dotfiles using GNU Stow, a symlink farm manager, which helps me organize and deploy these configurations across different machines easily.

## Installation

To deploy these dotfiles on your system:

1. Clone this repository to your home directory:
```bash
git clone https://github.com/mxsaad/dotfiles.git ~/dotfiles
```

2. Navigate to the cloned repository:
```bash
cd ~/dotfiles
```

3. Use GNU Stow to symlink the desired configurations. For example, to symlink the Bash and Vim configurations:
```bash
stow bash vim
```

Replace `bash` and `vim` with the names of the directories containing configurations you want to deploy.

## Usage

After symlinking the configurations using GNU Stow, the dotfiles will be effectively deployed on your system. Any changes made to these files within the repository will reflect on your system instantly.

To add new configurations or update existing ones:

1. Add or modify the configuration files within the respective directories in the repository.

2. Re-run the `stow` command for the configurations you've updated:
```bash
stow bash vim
```

This will update the symlinks accordingly.

## Contributing

Feel free to suggest improvements or contribute to this repository by opening issues or pull requests. Your feedback and contributions are highly appreciated!

## License

This repository is licensed under the [MIT License](LICENSE). Feel free to use and modify the configurations as you see fit.