aboutsummarylogtreecommitdiffstats
path: root/README.md
blob: 050ce25321ec57bc76312fafb06d80a3ccb82d72 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# Easy Zsh Config

- A simple but fast and out of the box configuration of zsh powered by oh-my-posh and zsh pulgins.

## Features

- Configure Zsh in one command line
- Rich themes (powered by `oh-my-posh`)
- Syntax highlighting (powered by `zsh-syntax-highlighting`)
- Provide suggestions of command automatically (powered by `zsh-autosuggestions`)
- History substring search (powered by `zsh-history-substring-search`)
- A lot of system infomation or git infomation provided (powered by `oh-my-posh`):
  - Current directory
  - Time cost of commands
  - Git status
  - Git branches
  - Battery persontage
  - Local time
  - Root permission prompt
- No theme or git plugin script written in `zsh` -- faster start up

## Usage

### Apply to the Current User

- If you already have the file `~/.zshrc`, you may want to back it up:

```zsh
mv ~/.zshrc ~/.zshrc.bak
```

- And run the following command to apply the configuration file to you home directory:

  - If you don't need to customize your `.zshrc` file and you want to keep your `.zshrc` file to the current one, run the following command:
  ```zsh
  ln -s /etc/zsh/zshrc ~/.zshrc
  ```
  - If you want to customize your `.zshrc` file, run:
  ```zsh
  cp /etc/zsh/zshrc ~/.zshrc
  ```

### Configure the Theme

- Edit line 2, ~/.zshrc, and replace default theme file path with your target theme file path.

### Key Usages

- `Up`:           History substring search(backward)
- `Down`:         History substring search(forward)
- `Ctrl-Up`:      History beginning search(backward)
- `Ctrl-Down`:    History beginning search(forward)
- `Ctrl-Left`:    Skip a whole word(left)
- `Ctrl-Right`:   Skip a whole word(right)
- `Tab`:          Command Completion
- `Ctrl-W`:       Delete a whole word(left)
- `Ctrl-U`:       Delete a whole line
- `Del`:          Delete a character after the cursor