set-me-up 👷🏼

A comprehensive dotfiles and system configuration framework.

Documentation

For detailed information about how set-me-up works, see the documentation.

For information about the setup and update scripts, see scripts/SCRIPTS.md.

Contributing

See CONTRIBUTING.md for development setup and how to run lint checks locally.

Quick Setup

To clone all repositories and recreate the complete directory structure:

git clone https://github.com/dotbrains/set-me-up.git
cd set-me-up
chmod +x scripts/setup.sh
./scripts/setup.sh

Updating Repositories

To update all repositories to their latest versions:

cd set-me-up
./scripts/update.sh

The update script will automatically skip repositories with uncommitted changes.

See scripts/SCRIPTS.md for detailed documentation on both scripts.

Directory Structure

set-me-up/
├── blueprint/          # Blueprint configuration
├── docs/               # Documentation
├── installer/          # Installation scripts
├── utilities/          # Utility scripts
├── modules/
│   ├── colorschemes/   # Color scheme configurations
│   ├── macports/       # MacPorts module
│   ├── preferences/    # Preferences module
│   ├── template-module/ # Template for new modules
│   ├── universal/      # Universal modules
│   └── xcode/          # Xcode module
└── home/.config/
    ├── alacritty/      # Alacritty terminal config
    ├── bash/           # Bash configuration
    ├── fish/           # Fish shell configuration
    ├── nushell/        # Nushell configuration
    ├── nvim/           # Neovim configuration
    ├── tmux/           # Tmux configuration
    └── zsh/            # Zsh configuration

Repositories

Core

• set-me-up-blueprint
• set-me-up-docs
• set-me-up-installer
• utilities

Modules

• colorschemes
• macports-module
• preferences-module
• template-module
• set-me-up-universal-modules
• xcode-module

Config

• alacritty
• bash
• fish
• nushell
• nvim
• tmux
• zsh

License

The code is available under the MIT license.