diff --git a/README.md b/README.md new file mode 100644 index 0000000..d397f48 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# 📂 Dotfiles + +Personal dotfiles for a Linux setup built around [Hyprland](https://github.com/hyprwm/Hyprland). + +## ✨ Features + +- 🔲 **Hyprland** – dynamic Wayland compositor configuration +- 📊 **Waybar** – status bar setup +- 🔤️ **Terminal** – configs for Foot, Alacritty +- 👚 **Shell** – Zsh/Bash with aliases and functions +- ⚙️ **Git** – global `.gitconfig` with useful settings +- ✍️ **Neovim** – minimal IDE setup +- 🔧 **Misc tools** – includes configs for `tmux`, `starship`, `wofi`, etc. + +## 📦 Installation + +Clone the repo: + +```bash +git clone https://github.com/yourusername/dotfiles.git ~/.dotfiles +``` + +Then manually symlink files or use a dotfile manager like: + +- [chezmoi](https://www.chezmoi.io/) +- [yadm](https://yadm.io/) + +> ⚠️ Note: These configs are optimized for a Hyprland-based environment. You may need to adapt them to your own system and preferences. + +## 🖼️ Screenshots + +*(Add screenshots here if you'd like to show your setup.)* + +## 📄 License + +MIT License