From d2e3ac5c4195dcf936343dfb3bf6901c4917e7d2 Mon Sep 17 00:00:00 2001 From: medusa Date: Fri, 8 Mar 2024 16:18:30 +0000 Subject: [PATCH] Update docs/tech_docs/linux/dotfiles.md --- docs/tech_docs/linux/dotfiles.md | 58 ++++++++++++++++---------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/docs/tech_docs/linux/dotfiles.md b/docs/tech_docs/linux/dotfiles.md index 557a24f..82f8ddc 100644 --- a/docs/tech_docs/linux/dotfiles.md +++ b/docs/tech_docs/linux/dotfiles.md @@ -1,79 +1,79 @@ -# Dotfiles Management Guide +# Custom Dotfiles Management Guide for Mouseless Development ## Overview -This guide outlines the process of organizing, backing up, and replicating your personal development environment through the management of dotfiles. Dotfiles are configuration files in Unix-like systems, hidden by default and used to customize your system's settings. +This guide is crafted for developers who prioritize a keyboard-centric approach, leveraging tools like VIM, TMUX, and the CLI. It outlines the organization, backup, and replication of dotfiles - the hidden configuration files that streamline and personalize your Unix-like systems. ## Steps to Get Started ### 1. **Create Your Dotfiles Directory** -- Create a directory in your home folder to store your dotfiles: +- Initiate a dedicated directory within your home folder to centrally manage your configurations: ```bash mkdir ~/dotfiles ``` ### 2. **Populate Your Dotfiles Directory** -- Move your existing configuration files into this directory: +- Relocate your critical configuration files to this newly created directory: ```bash mv ~/.vimrc ~/dotfiles/vimrc +mv ~/.tmux.conf ~/dotfiles/tmux.conf mv ~/.bashrc ~/dotfiles/bashrc -# Repeat for other configurations +# Extend to other essential configurations ``` -### 3. **Create Symlinks** -- Link your actual configuration files to the ones in the dotfiles directory: +### 3. **Establish Symlinks** +- Form symlinks from your home directory to the dotfiles in your repository: ```bash ln -s ~/dotfiles/vimrc ~/.vimrc +ln -s ~/dotfiles/tmux.conf ~/.tmux.conf ln -s ~/dotfiles/bashrc ~/.bashrc -# Repeat for each configuration file +# Apply for all moved configurations ``` -### 4. **Version Control** -- Initialize a Git repository to track your configurations: +### 4. **Incorporate Version Control** +- Utilize Git to track and manage changes to your dotfiles: ```bash cd ~/dotfiles git init git add . -git commit -m "Initial commit of my dotfiles" +git commit -m "Initial configuration setup for mouseless development" ``` -### 5. **Backup and Share Your Dotfiles** -- Push your dotfiles to a remote repository for backup and sharing: +### 5. **Backup and Collaboration** +- Sync your dotfiles to a remote repository for both backup and sharing purposes: ```bash git remote add origin git push -u origin master ``` -### 6. **Replicate Across Machines** -- Clone your dotfiles repository on any new machine and set up symlinks: +### 6. **Replication Across Systems** +- Clone and deploy your development setup on any new system efficiently: ```bash git clone ~/dotfiles -# Set up symlinks as before +# Recreate symlinks as previously outlined ``` -### 7. **Automate Setup** -- Create a setup script to automate the symlinking and installation process: +### 7. **Streamline Setup with Automation** +- Craft a setup script to facilitate the quick establishment of your environment: ```bash #!/bin/bash +# Automate symlinking ln -s ~/dotfiles/vimrc ~/.vimrc +ln -s ~/dotfiles/tmux.conf ~/.tmux.conf ln -s ~/dotfiles/bashrc ~/.bashrc -# Add other setup steps +# Automate additional steps as needed ``` -- Make it executable: +- Ensure the script is executable: ```bash chmod +x ~/dotfiles/setup.sh ``` ## Best Practices -- **Organization:** Keep your dotfiles directory well-organized with clear structure and naming. -- **Documentation:** Include a `README.md` with setup instructions and file explanations. -- **Privacy:** Ensure no sensitive data is included in your public dotfiles. +- **Structured Organization:** Maintain an orderly dotfiles directory, segregating configurations into logical groups or directories if needed. +- **Clear Documentation:** Equip your repository with a comprehensive `README.md` detailing setup instructions and configuration insights. +- **Security:** Vigilantly exclude any sensitive information from your public dotfiles to safeguard your privacy. -## Continuous Improvement +## Continuous Evolution -Regularly update your dotfiles as you refine your environment. Commit these changes to keep your repository current. Review and clean your configurations periodically to remove obsolete settings. - ---- - -This guide should serve as a solid foundation for managing your dotfiles effectively. Feel free to customize the process to suit your personal workflow and preferences. \ No newline at end of file +Embrace regular reviews and updates to your dotfiles, adapting and refining your setup to align with evolving preferences and discoveries in your mouseless development journey. \ No newline at end of file