comparison .zfun/zsh-autosuggestions/INSTALL.md @ 467:e1ce8897030d

zsh: import df6f6f9ff41 of zsh-autosuggestions
author Augie Fackler <raf@durin42.com>
date Mon, 03 Dec 2018 22:37:29 -0500
parents
children
comparison
equal deleted inserted replaced
466:f248cf012d9a 467:e1ce8897030d
1 ## Installation
2
3 ### Manual (Git Clone)
4
5 1. Clone this repository somewhere on your machine. This guide will assume `~/.zsh/zsh-autosuggestions`.
6
7 ```sh
8 git clone https://github.com/zsh-users/zsh-autosuggestions ~/.zsh/zsh-autosuggestions
9 ```
10
11 2. Add the following to your `.zshrc`:
12
13 ```sh
14 source ~/.zsh/zsh-autosuggestions/zsh-autosuggestions.zsh
15 ```
16
17 3. Start a new terminal session.
18
19 ### Antigen
20
21 1. Add the following to your `.zshrc`:
22
23 ```sh
24 antigen bundle zsh-users/zsh-autosuggestions
25 ```
26
27 2. Start a new terminal session.
28
29 ### Oh My Zsh
30
31 1. Clone this repository into `$ZSH_CUSTOM/plugins` (by default `~/.oh-my-zsh/custom/plugins`)
32
33 ```sh
34 git clone https://github.com/zsh-users/zsh-autosuggestions ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-autosuggestions
35 ```
36
37 2. Add the plugin to the list of plugins for Oh My Zsh to load (inside `~/.zshrc`):
38
39 ```sh
40 plugins=(zsh-autosuggestions)
41 ```
42
43 3. Start a new terminal session.
44
45 ### Arch Linux
46
47 1. Install [`zsh-autosuggestions`](https://www.archlinux.org/packages/community/any/zsh-autosuggestions/) from the `community` repository.
48
49 ```sh
50 pacman -S zsh-autosuggestions
51 ```
52
53 or, to use a package based on the `master` branch, install [`zsh-autosuggestions-git`](https://aur.archlinux.org/packages/zsh-autosuggestions-git/) from the [AUR](https://wiki.archlinux.org/index.php/Arch_User_Repository).
54
55 2. Add the following to your `.zshrc`:
56
57 ```sh
58 source /usr/share/zsh/plugins/zsh-autosuggestions/zsh-autosuggestions.zsh
59 ```
60
61 3. Start a new terminal session.
62
63 ### macOS via Homebrew
64 1. Install the `zsh-autosuggestions` package using [Homebrew](https://brew.sh/).
65
66 ```sh
67 brew install zsh-autosuggestions
68 ```
69
70 2. Add the following to your `.zshrc`:
71
72 ```sh
73 source /usr/local/share/zsh-autosuggestions/zsh-autosuggestions.zsh
74 ```
75
76 3. Start a new terminal session.
77