Skip to content

Commit 6233d81

Browse files
committed
modified: README.md
1 parent cb513bf commit 6233d81

File tree

1 file changed

+33
-36
lines changed

1 file changed

+33
-36
lines changed

README.md

Lines changed: 33 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,42 @@
33
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
44
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
55

6-
- [Inroduction](#inroduction)
7-
- [Installation](#installation)
6+
- [Introduction](#introduction)
7+
- [Installation](#installation)
88
- [Installation With Zinit](#installation-with-zinit)
99
- [Installation With Zgen](#installation-with-zgen)
1010
- [Installation With Antigen](#installation-with-antigen)
1111
- [Manual Installation](#manual-installation)
1212
- [Single File Manual Installation](#single-file-manual-installation)
13-
- [Introduction](#introduction)
14-
- [Performance](#performance)
15-
- [Fixing tmux, screen and linux vt](#fixing-tmux-screen-and-linux-vt)
13+
- [Performance](#performance)
14+
- [Fixing tmux, screen and linux vt](#fixing-tmux-screen-and-linux-vt)
1615

1716
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1817

19-
# Inroduction
18+
## Introduction
19+
20+
`ZCA` allows to copy segments of commands in history, rearrange segments of current command,
21+
delete segments of current command. This way user glues command from parts without using
22+
a mouse. Advanced history search (multi word, without duplicate lines) allows to quickly find
23+
the parts.
24+
25+
Keys are:
26+
27+
- `Ctrl-T` - start Zsh Command Architect (Zshell binding)
28+
- `Enter` - delete selected segment (when in command window) or add selected segment (when in history window)
29+
- `[` or `]` - move active segment (when in command window)
30+
- `Shift-left` or `Shift-right` - move active segment (when in command window)
31+
- `Tab` - switch between the two available windows
32+
- `g, G` - beginning and end of the list
33+
- `/` - start incremental search
34+
- `Esc` - exit incremental search, clearing filter
35+
- `<`,`>`, `{`,`}` - horizontal scroll
36+
- `Ctrl-L` - redraw of whole display
37+
- `Ctrl-O`, `o` - enter uniq mode (no duplicate lines)
38+
- `Ctrl-W` (in incremental search) - delete whole word
39+
- `Ctrl-K` (in incremental search) - delete whole line
40+
- `Ctrl-D`, `Ctrl-U` - half page up or down
41+
- `Ctrl-P`, `Ctrl-N` - previous and next (also done with vim's j,k)
2042

2143
Also check out [Zsh Navigation Tools](https://github.com/z-shell/zsh-navigation-tools)
2244
and [Zsh Editing Workbench](https://github.com/z-shell/zsh-editing-workbench)
@@ -34,21 +56,21 @@ will be updated with only `4` lines of code that will be added to the bottom.
3456

3557
After installing and reloading shell give `ZCA` a quick try with `Ctrl-T`.
3658

37-
## Installation With [Zinit](https://github.com/z-shell/zinit)
59+
### Installation With [Zinit](https://github.com/z-shell/zinit)
3860

3961
Add `zinit load z-shell/zsh-cmd-architect` to `.zshrc`. The config files will be available in `~/.config/zca`.
4062

41-
## Installation With Zgen
63+
### Installation With Zgen
4264

4365
Add `zgen load z-shell/zsh-cmd-architect` to `.zshrc` and issue a `zgen reset` (this assumes that there is a proper `zgen save` construct in `.zshrc`).
4466
The config files will be available in `~/.config/zca`.
4567

46-
## Installation With Antigen
68+
### Installation With Antigen
4769

4870
Add `antigen bundle z-shell/zsh-cmd-architect` to `.zshrc`. There also
4971
should be `antigen apply`. The config files will be in `~/.config/znt`.
5072

51-
## Manual Installation
73+
### Manual Installation
5274

5375
After extracting `ZCA` to `{some-directory}` add following two lines to `~/.zshrc`:
5476

@@ -68,36 +90,11 @@ source "{some-directory}/zsh-cmd-architect.plugin.zsh"
6890
because `ZCA` detects if it is used by **any** plugin manager and can
6991
handle `$fpath` update by itself.
7092

71-
## Single File Manual Installation
93+
### Single File Manual Installation
7294

7395
Running script `doc/generate_single_file` will create single-file version of `ZCA`.
7496
It can be sourced from `.zshrc`. Don't forget about configuration files (copy them to `~/.config/zca`).
7597

76-
## Introduction
77-
78-
`ZCA` allows to copy segments of commands in history, rearrange segments of current command,
79-
delete segments of current command. This way user glues command from parts without using
80-
a mouse. Advanced history search (multi word, without duplicate lines) allows to quickly find
81-
the parts.
82-
83-
Keys are:
84-
85-
- `Ctrl-T` - start Zsh Command Architect (Zshell binding)
86-
- `Enter` - delete selected segment (when in command window) or add selected segment (when in history window)
87-
- `[` or `]` - move active segment (when in command window)
88-
- `Shift-left` or `Shift-right` - move active segment (when in command window)
89-
- `Tab` - switch between the two available windows
90-
- `g, G` - beginning and end of the list
91-
- `/` - start incremental search
92-
- `Esc` - exit incremental search, clearing filter
93-
- `<`,`>`, `{`,`}` - horizontal scroll
94-
- `Ctrl-L` - redraw of whole display
95-
- `Ctrl-O`, `o` - enter uniq mode (no duplicate lines)
96-
- `Ctrl-W` (in incremental search) - delete whole word
97-
- `Ctrl-K` (in incremental search) - delete whole line
98-
- `Ctrl-D`, `Ctrl-U` - half page up or down
99-
- `Ctrl-P`, `Ctrl-N` - previous and next (also done with vim's j,k)
100-
10198
## Performance
10299

103100
`ZCA` is fastest with `Zsh` before `5.0.6` and starting from `5.2`

0 commit comments

Comments
 (0)