Update README to reflect current setup

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
kappa
2026-02-09 09:47:32 +09:00
parent 99ad121620
commit d4041bfb95

View File

@@ -1,97 +1,63 @@
# Dotfiles # Dotfiles
Personal configuration files managed with GNU Stow. Personal configuration files managed with [GNU Stow](https://www.gnu.org/software/stow/).
## Contents ## Contents
- **tmux**: Terminal multiplexer configuration - **nvim**: Neovim (LazyVim + Dracula theme, python/yaml/docker/json/markdown extras)
- **kitty**: Modern terminal emulator configuration - **tmux**: tmux (Dracula theme)
- **nvim**: Neovim configuration (AstroNvim based) - **kitty**: Kitty terminal (Dracula theme, Fira Code Nerd Font)
- **fish**: Fish shell configuration with Fisher plugins - **fish**: Fish shell (Fisher, fzf.fish, nvm)
## Installation ## Installation
### Prerequisites
```bash ```bash
# Install Homebrew (if not installed) # Prerequisites
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
# Install GNU Stow
brew install stow brew install stow
```
### Clone and Deploy # Clone and deploy
git clone https://gitea.anvil.it.com/kaffa/dotfiles.git ~/dotfiles
```bash
# Clone the repository
git clone https://git.anvil.it.com/kaffa/dotfiles.git ~/dotfiles
# Navigate to dotfiles directory
cd ~/dotfiles cd ~/dotfiles
stow fish kitty nvim tmux
# Deploy configurations (choose what you need)
stow tmux # Deploy tmux config
stow kitty # Deploy kitty config
stow nvim # Deploy nvim config
stow fish # Deploy fish config
# Or deploy all at once
stow tmux kitty nvim fish
``` ```
## Management ## Management
### Add new configuration
```bash ```bash
# Example: Adding a new tool configuration # Add new package
mkdir -p ~/dotfiles/toolname/.config/toolname mkdir -p ~/dotfiles/toolname/.config/toolname
cp -r ~/.config/toolname/* ~/dotfiles/toolname/.config/toolname/ cp -r ~/.config/toolname/* ~/dotfiles/toolname/.config/toolname/
stow toolname stow toolname
```
### Update existing configuration # Remove package
Configurations are symlinked, so any changes made to the actual config files will automatically be reflected in the repository. Just commit and push the changes:
```bash
cd ~/dotfiles
git add .
git commit -m "Update configurations"
git push
```
### Remove configuration
```bash
# Unstow (remove symlinks)
stow -D tmux stow -D tmux
# Or remove all # Dry run (simulate)
stow -D tmux kitty nvim fish stow -n -v tmux
``` ```
## Structure ## Structure
``` ```
~/dotfiles/ ~/dotfiles/
├── tmux/ ├── fish/
│ └── .tmux.conf │ └── .config/fish/
│ ├── config.fish
│ ├── completions/
│ ├── conf.d/
│ ├── functions/
│ └── themes/
├── kitty/ ├── kitty/
│ └── .config/ │ └── .config/kitty/
│ ├── kitty.conf │ ├── kitty.conf
│ └── dracula.conf │ └── dracula.conf
├── nvim/ ├── nvim/
│ └── .config/ │ └── .config/nvim/
── nvim/ ── init.lua
└── fish/ │ ├── lazyvim.json
└── .config/ └── lua/
── fish/ ── config/
│ └── plugins/
└── tmux/
└── .tmux.conf
``` ```
## Notes
- Original configuration files are backed up to `~/backups/` before stowing
- Use `stow -n <package>` to simulate what will happen without making changes
- Use `stow -v <package>` for verbose output to see what's being linked