Skip to content

README.md

Latest commit

 

History

History
87 lines (59 loc) · 2.63 KB

README.md

File metadata and controls

87 lines (59 loc) · 2.63 KB
Raw

🌟 dotfiles

A simple yet powerful setup for rapidly bootstrapping your macOS development environment.

Effortlessly configure your system preferences, install essential tools, and manage your configuration files using Brew, Devbox, Zinit, Stow, Starship, and more.

🚀 Quick Start

Download this repo.

Then open your terminal, paste the following command, and hit Enter:

mv ~/Downloads/dotfiles-main ~/dotfiles && \
cd ~/dotfiles && \
chmod +x install.sh && \
bash install.sh

🎉 Done! Grab a coffee ☕ while your Mac sets itself up. Note: You may need to interact with a few prompts during install.

📦 What's Included?

  • 🍺 Homebrew: Installs essential macOS utilities.
  • 📌 macOS Defaults: Sensible system defaults for a better experience.
  • 🔐 SSH & GPG Configuration: Secure Git and system access.
  • 🌌 Starship Prompt: Minimal, blazing-fast shell prompt.
  • ⚡ Zinit: Powerful Zsh plugin manager.
  • 🧰 Devbox: Isolated development environments with Nix.
  • 📁 Stow: Efficient dotfile management through symbolic linking.

🛠️ Customizing Your Setup

  • Update personal information (e.g., email and hostname) in the install.sh script before running.
  • Modify the Brewfile to add or remove software packages.
  • Tweak configurations (.zshrc, devbox.json, starship.toml) as desired—it's fully modular!

📂 Structure Overview

.
├── Brewfile                    # macOS packages
├── install.sh                  # Main bootstrap script
├── macos                       # macOS defaults scripts
│   ├── defaults.sh
│   └── hostname.sh
├── setup-scripts               # Configuration scripts
│   ├── configure-git.sh
│   ├── configure-gpg.sh
│   └── configure-ssh.sh
├── .config                     # Configurations for various tools
│   ├── starship.toml
├── devbox.json                 # Devbox global config
├── .gitignore                  # Git ignore file
├── .stow-local-ignore          # Stow ignored files/directories
├── .zshrc                      # Custom Zsh configuration
└── README.md                   # You are here 🚩

🤝 Contributing

Improvements, fixes, or tweaks welcome! Feel free to open a pull request.

🌟 Enjoy your new streamlined macOS setup! 🌟

🙌 Acknowledgments

Special thanks to Viktor Farcic whose work inspired this dotfiles setup.

Check out their original project at: DevOpsToolkit