Skip to content

Latest commit

 

History

History
34 lines (28 loc) · 1.98 KB

README.md

File metadata and controls

34 lines (28 loc) · 1.98 KB
Raw

dotfiles

To sync my dotfiles.

Prerequisites

  • Unix-like operating system (macOS or Linux)
  • Zsh should be installed (v4.3.9 or more recent). If not pre-installed (zsh --version to confirm), check the following instruction here: Installing ZSH
    • After installation, change zsh to default shell with chsh -s $(which zsh)
  • Oh My Zsh should be installed. Installation can be done with one line of command:
    • via curl: sh -c "$(curl -fsSL https://raw.github.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
    • via wget: sh -c "$(wget https://raw.github.com/ohmyzsh/ohmyzsh/master/tools/install.sh -O -)"
  • Homebrew should be installed
  • (Optional but really recommended) Increase key repeat speed 
    ❯ defaults write -g InitialKeyRepeat -int 20
❯ defaults write -g KeyRepeat -int 2
# Confirm it is working
❯ defaults read -g InitialKeyRepeat
20
❯ defaults read -g KeyRepeat
2

Usage

  1. Clone this git repo to your home directory: cd ~ && git clone https://github.com/gtbai/dotfiles.git
  2. Run setup_mac.sh to set up the configuration for MacOS machines, setup_linux.sh for Linux.
  3. As some vim plugins are too big to be uploaded to GitHub, you need to install them by yourself. Do not be terrified though, this can be done with a one-line command as well. In vim, under normal mode, type :PlugInstall and press Enter, then the beautiful vim-plug will do the work for you.
  4. (Optional) Re-configure the prompt appearance with p10k configure.
  5. Enjoy!

WARNING

Running setup.sh will overwrite your Vim, Tmux and Zsh configuration files, i.e. .vimrc, .tmux.conf and .zshrc. Please back them up before running setup.sh when necessary.