diff --git a/README.md b/README.md index dd4ca58..b141e51 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,49 @@ -# dotfiles +# 🛠️ dotfiles -This repository is useful for me to save all configurations of my shell and tools that I use -The repository is organized so that configurations can be installed via [GNU Stow](https://www.gnu.org/software/stow/). -Below is a list of the software: +Welcome to my **dotfiles** repository — a centralized collection of my personal configurations for shells, editors, terminal emulators, and various CLI tools that I use on a daily basis in Unix-like environments. -- Bash -- Bat -- Fastfetch -- Fish -- Foot -- Fuzzel -- Git -- k9s -- Kitty -- Lazydocker -- Lazygit -- Mako -- Neovim/LazyVim -- Starship -- Sway -- Tmux -- Vim -- Waybar -- Zoxide -- Zsh +The main goal of this repository is to maintain a consistent, portable, and version-controlled setup. The configuration files are organized to be easily managed and installed using [GNU Stow](https://www.gnu.org/software/stow/), following a modular and declarative structure. + +### 📦 Structure & Usage + +Each directory in this repository corresponds to a specific application or tool, with configuration files laid out to mirror the structure of the home directory. Using `stow`, symbolic links are created seamlessly, preserving organization and keeping configurations isolated per tool. + +> Example usage (from the repository root): +> ```bash +> stow nvim +> stow zsh +> ``` + +### 🧩 Included Tools & Configurations + +This repository contains my configuration files for the following tools: + +- **Shells & Prompt** + - `zsh` + `starship` + - `bash` + - `fish` +- **Terminal Emulator & Multiplexer** + - `foot` + - `kitty` + - `tmux` +- **Editors & CLI Tools** + - `neovim` (with LazyVim) + - `vim` + - `bat` + - `git` + - `lazygit` + - `lazydocker` + - `k9s` +- **Wayland Environment** + - `fuzzel` (launcher) + - `waybar` (status bar) + - `mako` (notification daemon) + - `sway` (window manager) +- **Utilities** + - `fastfetch` + - `zoxide` + +--- + +Feel free to explore, reuse, or adapt any part of this setup. +Issues and pull requests are welcome!