diff --git a/README.md b/README.md index 9a77dcb..8544fe1 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,58 @@ -# Some Notes -__ To be worked into a setup script at some point __ -## Clone repo -``` +# Dotfiles + +A collection of configuration files for various tools and applications I use, with an installation script to easily set them up on new systems. + +## Installation + +### Clone the repository + +```bash git clone git@github.com:sebaschi/dotfiles.git ~/.dotfiles ``` +{ -## Symlink files to correct locations -``` -ln -s ~/.dotfiles/git/gitconfig ~/.gitconfig -``` -``` -ln -s ~/.dotfiles/vim/vimrc ~/.vimrc -``` -``` -ln -s ~/.dotfiles/bash/bashrc ~/.bashrc -``` -## Apps/Tools I use -* 'exa' as replacement for 'ls' -* starship.io -* 'neofetch' CLI for system (OS mostly) info -* 'ncdu" CLI disk use info -* 'htop' process/cpu info. replacement for 'top' -* neovim with lazy.nvim +### Install configurations +The `dot-install` script can be used to install specific configurations or all of them at once: + +```bash +# Install everything +~/.dotfiles/dot-install all + +# Install specific configurations +~/.dotfiles/dot-install git nvim tmux + +# Install only bash aliases +~/.dotfiles/dot-install bash:aliases +``` + +Run `~/.dotfiles/dot-install` without arguments to see all available options. + +## Testing + +A test script is included to verify the installation script works correctly: + +```bash +~/.dotfiles/test-dot-install +``` + +This runs the installation in an isolated environment to ensure all symlinks are correctly created. + +## Included Configurations + +* **Shells**: Bash, Fish, Zsh +* **Terminal**: Tmux, Zellij, Ghostty +* **Editors**: Vim, Neovim (with lazy.nvim) +* **Tools**: Git, Starship prompt, Borg backup +* **Utilities**: Rsync filters + +## Tools Tools + +* `eza` - Modern replacement for `ls` +* `starship.io` - Cross-shell prompt +* `neofetch` - System information tool +* `ncdu` - Disk usage analyzer +* `btop` - Interactive process viewer (replacement for `top`) +* `neovim` - Enhanced vim editor +> [!note] +> TODO: add more tools!