This repository provides a comprehensive set of dotfiles for macOS users, aiming to create a streamlined and efficient development environment. It targets developers who prefer a highly customized terminal experience with Neovim, Zsh/Fish, and the Kitty terminal emulator, offering an idempotent setup process.

How It Works

The configuration leverages GNU Stow for managing symbolic links of configuration files to the user's home directory, ensuring an idempotent and repeatable setup. It utilizes a fork of thoughtbot's laptop script for bootstrapping a new macOS machine, which installs essential tools like Git, Homebrew, asdf, Ruby, Node.js, Zsh, Fish, and Neovim. The Neovim setup is based on the LazyVim distribution, providing a modern, Lua-driven IDE experience.

Quick Start & Requirements

• Install: Clone the repository and run the setup.sh script:

  git clone https://github.com/joshukraine/dotfiles.git ~/dotfiles
  bash ~/dotfiles/setup.sh
  

• Prerequisites: macOS, Git, Homebrew (including coreutils), asdf, Ruby, Node.js, Zsh and/or Fish, Neovim, Starship. These are installed via the laptop script.
• Setup Time: Estimated to be relatively quick after initial macOS setup, primarily dependent on software installation times.
• More Info: New Mac Bootstrap, Zsh Setup Instructions, Fish Setup Instructions

Highlighted Details

• Supports both Zsh and Fish shells with near-functional parity.
• Recommends Kitty terminal emulator over iTerm2+Tmux for a simplified, GPU-accelerated experience.
• Includes configurations for popular programming fonts with ligature support and Nerd Fonts for icons.
• Provides detailed guidance on optimizing Zsh startup times and Neovim performance.

Maintenance & Community

The repository is maintained by joshukraine. Further community interaction details are not explicitly provided in the README.

Licensing & Compatibility

• License: MIT License.
• Compatibility: Permissive license suitable for commercial use and integration with closed-source projects.

Limitations & Caveats

The dotfiles are specifically tailored for macOS and may require significant adaptation for other operating systems. While offering support for both Zsh and Fish, users must choose their preferred shell during setup. The transition from Tmux to Kitty is presented as a simplification, but users preferring Tmux can re-enable it with minor configuration changes.