ogrre / .dotfiles

My personal dotfiles config for differents computer

Dotfiles repository

Getting Started

Cloning the Project

To get started, you'll need to clone this repository to your local machine. Open a terminal and run the following command:

git clone https://github.com/0grre/.dotfiles.git ~/.dotfiles

This command clones the repository into the .dotfiles directory in your home folder.

Installation

Before running the installation script, ensure you have rsync installed on your system, as our synchronization scripts rely on it.

1. Install rsync:

• On macOS: rsync is pre-installed.
• On Linux: Install rsync using your package manager, e.g., sudo apt-get install rsync for Debian/Ubuntu.

2. Run the Installation Script:

Navigate to the .dotfiles directory and run the installation script:

cd ~/.dotfiles
./install_hook.sh

This script sets up the necessary Git hooks for automatic synchronization.

Scripts Overview

install_hooks.sh

Purpose: Sets up Git hooks for automatic synchronization of your dotfiles.

How to Run:

./install_hook.sh

Run this script once after cloning the repository to ensure the post-merge hook is properly installed.

sync_files.sh

Purpose: Synchronizes configurations between .dotfiles/.config and your system's .config directory, ensuring that any updates are reflected in both locations. This script can be run manually or automatically via a git hook after committing changes to the dotfiles repository.

You can run this script manually to synchronize your configurations at any time, or it can be automatically triggered by committing changes to the dotfiles repository using the git hook.

How to Run:

./sync_files.sh

upload_files.sh

Purpose: Uploads configurations from your system's .config directory to .dotfiles/.config, ensuring that any changes you've made to your configurations are saved in your dotfiles repository.

How to Run:

./upload_files.sh

You can run this script manually to upload your configurations at any time. It is recommended to run this script before committing changes to your dotfiles repository, to ensure that your repository is up to date with your current configurations. This will allow you to synchronize your configurations across multiple systems and keep a backup of your configurations in your dotfiles repository.

How It Works

Post-Merge Hook: After any git pull operation, the post-merge hook automatically triggers the synchronization script to update your configurations.

Synchronization Script: This script uses rsync to sync files and directories between .dotfiles/.config and your system's .config, ensuring the latest configurations are always in use.

Contributing

Contributions are welcome! If you have improvements or fixes, please fork the repository and submit a pull request.

Support