Shawn's dotfiles

• Shawn's dotfiles
  • Support OS
  • Requirements
  • Include Function
  • How to use
  • ".env" file setting example

Support OS

• Debian-based Linux
  • Ubuntu >= 24.04
• Arch-based Linux
  • Arch Linux
• MacOS

Requirements

1. zsh >= 5.8.1
2. neovim >= 0.8

Include Function

1. useful packages package list: aria2, bat, exa, fd, fzf, ripgrep, thefuck, tmux, zoxide

   NOTE: You may need Administrator to install packages.

2. git config
3. neovim config
4. tmux config
5. zsh config and alias
6. Remap key: exchange ctrl_L and alt_L

How to use

1. Download and modify env file

   cd ~ && git clone https://github.com/shdennlin/dotfiles.git ~/.dotfiles/
   cd ~/.dotfiles
   cp .env.example .env

2. Edit the .env file -> .env file setting example

3. Install from terminal

   ./install.sh

4. After install, you need to restart your terminal. At the first restart, you need to wait for a while(10-30s) to install plugins

5. (option) speed up zsh type following on terminal

   znap compile

".env" file setting example

useful_package=y # y or n
git_config=y # y or n
neovim_config=y # y or n
tmux_config=y # y or n
zsh_config=y # y or n
keymap=n # y or n