Skip to content

Latest commit

 

History

History
120 lines (76 loc) · 2.16 KB

README.md

File metadata and controls

120 lines (76 loc) · 2.16 KB

🛠️ .dotfiles

This repository contains configuration files (dotfiles) to set up your development environment consistently across machines.

📌 Important: Clone this repository into your $HOME directory as ~/dotfiles and use symbolic links to activate each config.

🔗 How to Link

ln -s <source> <target>
# Example:
ln -s ~/dotfiles/.zshrc ~/.zshrc

You can automate the entire setup using the setup-machine script from a companion scripts repo.

📦 Components

🧠 Neovim (nvim)

Steps:

ln -s ~/dotfiles/nvim ~/.config/nvim

🔀 Hyprland (hypr)

  • A Wayland compositor, commonly used on Arch Linux btw
  • Located in: dotfiles/hypr

Steps:

ln -s ~/dotfiles/hypr ~/.config/hypr

📿 Tmux (tmux)

  • Terminal multiplexer with custom config and TPM plugin manager
  • Located in: dotfiles/tmux

Steps:

# Ensure tmux is installed
ln -s ~/dotfiles/tmux ~/.config/tmux

💻 WezTerm (wezterm)

  • GPU-accelerated terminal emulator written in Rust
  • Located in: dotfiles/wezterm

Steps:

# Ensure wezterm is installed
ln -s ~/dotfiles/wezterm ~/.config/wezterm

👚 Zsh

  • Z shell setup using oh-my-zsh and custom dotfiles

  • Files:

    • .zshrc
    • .zprofile
    • .zshenv
    • .zexports

Steps:

ln -s ~/dotfiles/.zshrc ~/.zshrc
ln -s ~/dotfiles/.zprofile ~/.zprofile
ln -s ~/dotfiles/.zshenv ~/.zshenv
ln -s ~/dotfiles/.zexports ~/.zexports

⚙️ Automated Setup (Optional)

You can automate the linking process using a setup script:

git clone https://github.com/armedev/scripts ~/scripts
bash ~/scripts/setup-machine

The script supports flags like --dry-run, --force, and --with-hypr.

📜 License

MIT License. Use freely, modify responsibly. Contributions welcome.

🙌 Contributing

Feel free to fork and PR improvements or open issues if you have suggestions or bugs to report.