Skip to content

setup.md

Latest commit

 

History

History
91 lines (59 loc) · 2.23 KB

setup.md

File metadata and controls

91 lines (59 loc) · 2.23 KB

Setup & Installation Guide

Welcome to DeveloperSet! Follow these steps to get started:

Prerequisites

  • macOS or Linux - Latest Stable Release or Beta version
  • Bash, Zsh, or a compatible shell (v4+)
  • jq installed (for JSON parsing) - Latest version

1. Clone the Repository

git clone <your-repo-url>
cd DeveloperSet

2. Review and Edit Config Files

Edit the files in the config/ directory to match your preferences:

  • dotfiles.json: Manage dotfiles and templates
  • folders.json: Define your folder structure
  • tools.json: Specify development tools and packages

3. Run Individual Setup Scripts (Optional & not recommended)

  • ./setup/dotfiles_linker.sh — Only link dotfiles
  • ./setup/folder_creator.sh — Only create folders
  • ./setup/permissions.sh — Set permissions

4. Custom Hooks

If you have pre/post setup hooks defined in your config files, they will run automatically.

5. Configure your .zshrc

The installer has many Homebrew caveats. Add this to your .zshrc to handle them to not occur errors:

nano ~/.zshrc

Paste the following:

# Add Homebrew curl to PATH
export PATH="/opt/homebrew/opt/curl/bin:$PATH"

# Add compiler flags for curl
export LDFLAGS="-L/opt/homebrew/opt/curl/lib"
export CPPFLAGS="-I/opt/homebrew/opt/curl/include"

# Add pkg-config path for curl
export PKG_CONFIG_PATH="/opt/homebrew/opt/curl/lib/pkgconfig"

# Activate zsh plugins
source /opt/homebrew/share/zsh-autosuggestions/zsh-autosuggestions.zsh
source /opt/homebrew/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh

# Set ZSH syntax highlighting path
export ZSH_HIGHLIGHT_HIGHLIGHTERS_DIR=/opt/homebrew/share/zsh-syntax-highlighting/highlighters

# Make modern bash permanent
export PATH="/opt/homebrew/bin:$PATH"

6. Start installing Script

This will set up folders, link dotfiles, and install tools:

./install.sh

Do NOT run install.sh or other script with sudo permissions!

After installation, source your zshrc:

source ~/.zshrc

Troubleshooting

  • Ensure all scripts are executable: chmod +x setup/*.sh
  • Check the FAQ (docs/faq.md) for common issues.

Need Help?

See CONTRIBUTING.md or open an issue in the repository.