Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Pull out separate doc for installation instructions
- Loading branch information
1 parent
c113e49
commit 72ccee3
Showing
2 changed files
with
70 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
## Installation | ||
|
||
### Manual (Git Clone) | ||
|
||
1. Clone this repository somewhere on your machine. This guide will assume `~/.zsh/zsh-autosuggestions`. | ||
|
||
```sh | ||
git clone https://github.com/zsh-users/zsh-autosuggestions ~/.zsh/zsh-autosuggestions | ||
``` | ||
|
||
2. Add the following to your `.zshrc`: | ||
|
||
```sh | ||
source ~/.zsh/zsh-autosuggestions/zsh-autosuggestions.zsh | ||
``` | ||
|
||
3. Start a new terminal session. | ||
|
||
### Oh My Zsh | ||
|
||
1. Clone this repository into `$ZSH_CUSTOM/plugins` (by default `~/.oh-my-zsh/custom/plugins`) | ||
|
||
```sh | ||
git clone https://github.com/zsh-users/zsh-autosuggestions ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-autosuggestions | ||
``` | ||
|
||
2. Add the plugin to the list of plugins for Oh My Zsh to load: | ||
|
||
```sh | ||
plugins=(zsh-autosuggestions) | ||
``` | ||
|
||
3. Start a new terminal session. | ||
|
||
### Arch Linux | ||
|
||
1. Install [`zsh-autosuggestions`](https://www.archlinux.org/packages/community/any/zsh-autosuggestions/) from the `community` repository. | ||
|
||
```sh | ||
pacman -S zsh-autosuggestions | ||
``` | ||
|
||
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). | ||
|
||
2. Add the following to your `.zshrc`: | ||
|
||
```sh | ||
source /usr/share/zsh/plugins/zsh-autosuggestions/zsh-autosuggestions.zsh | ||
``` | ||
|
||
3. Start a new terminal session. | ||
|
||
### macOS via Homebrew | ||
1. Install the `zsh-autosuggestions` package using [Homebrew](https://brew.sh/). | ||
|
||
```sh | ||
brew install zsh-autosuggestions | ||
``` | ||
|
||
2. Add the following to your `.zshrc`: | ||
|
||
```sh | ||
source /usr/local/share/zsh-autosuggestions/zsh-autosuggestions.zsh | ||
``` | ||
|
||
3. Start a new terminal session. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters