From 0cb38447fc95836a1b03c104361d7639d2671fa5 Mon Sep 17 00:00:00 2001 From: Sarthak Jain Date: Sun, 15 Mar 2026 10:43:56 +0530 Subject: [PATCH] Modify README --- README.md | 53 ++++++++++++++++++++++++----------------------------- 1 file changed, 24 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 5337a49..3988f30 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This repository contains my personal dotfiles, managed using [GNU Stow](https://www.gnu.org/software/stow/). -Instead of a custom installation script, configurations are organized into logical "packages". Using `stow` ensures that all configuration files are cleanly symlinked into your home directory, mirroring the structure inside the package folder. +Using `stow` ensures that all configuration files are cleanly symlinked into your home directory, mirroring the structure of this repository. ## Requirements @@ -27,52 +27,47 @@ sudo pacman -S stow ## Installation -To install a specific package (e.g., `nvim`), navigate to the root of this repository and run: +To install all configurations at once, navigate to the root of this repository and run: ```bash -stow nvim -``` - -To install all standard packages at once, run: - -```bash -stow bash zsh nvim starship tmux +stow . ``` This will automatically create the necessary symlinks in your `$HOME` directory pointing to the files in this repository. -### Removing a Package +### Removing Configurations -If you want to remove the symlinks for a specific package, use the `-D` flag: +If you want to remove the symlinks created by Stow, use the `-D` flag: ```bash -stow -D nvim +stow -D . ``` ## Directory Structure -To keep things modular and easy to manage, each folder acts as a "package" that represents an application or environment. The folder structure *inside* the package strictly mirrors its target destination relative to the home (`~/`) directory. +The folder structure directly mirrors its target destination relative to the home (`~/`) directory. ```text . -├── bash/ -│ └── .bashrc # Symlinked to ~/.bashrc -├── nvim/ -│ └── .config/ -│ └── nvim/ # Symlinked to ~/.config/nvim/ -├── starship/ -│ └── .config/ -│ └── starship.toml # Symlinked to ~/.config/starship.toml -├── tmux/ -│ ├── .tmux.conf # Symlinked to ~/.tmux.conf -│ └── .tmux.conf.local # Symlinked to ~/.tmux.conf.local -└── zsh/ - └── .zshrc # Symlinked to ~/.zshrc +├── .bashrc # Symlinked to ~/.bashrc +├── .config/ # Symlinked to ~/.config/ +│ ├── alacritty/ +│ ├── kitty/ +│ ├── nvim/ +│ ├── starship.toml +│ └── ... +├── .fonts/ # Symlinked to ~/.fonts/ +├── .tmux.conf # Symlinked to ~/.tmux.conf +├── .tmux.conf.local # Symlinked to ~/.tmux.conf.local +├── .vimrc # Symlinked to ~/.vimrc +├── .zshrc # Symlinked to ~/.zshrc +├── scripts/ # Symlinked to ~/scripts/ +├── shell/ # Symlinked to ~/shell/ +└── wezterm.lua # Symlinked to ~/wezterm.lua ``` ### Adding New Configurations When you want to add a new tool: -1. Create a new directory for it (e.g., `wezterm`). -2. Replicate the target directory structure inside this new folder (e.g., `wezterm/.config/wezterm/wezterm.lua`). -3. Run `stow wezterm` from the root of this repository. +1. Replicate the target directory structure inside this repository (e.g., `.config/new_tool/config.toml`). +2. Run `stow .` from the root of this repository to link the new files.