diff --git a/README.md b/README.md index a230d95..985cb97 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ # dotfiles -my personal dotfiles, shell scripts and system configurations \ No newline at end of file +My personal dotfiles, shell scripts, and system configurations. + +## Contents + +| Folder | Description | +|--------|-------------| +| `fastfetch/` | Fastfetch configs and ascii art | +| `scripts/` | General purpose shell scripts | +| `scripts/gum/` | Interactive shell scripts using Gum | +| `vscodium/` | VSCodium settings | +| `zsh/` | Zsh config/aliases | + +## Requirements + +- [fzf](https://github.com/junegunn/fzf) +- [eza](https://github.com/eza-community/eza) +- [glow](https://github.com/charmbracelet/glow) +- [gum](https://github.com/charmbracelet/gum) +- [fastfetch](https://github.com/fastfetch-cli/fastfetch)