mirror of
https://github.com/zsh-users/zsh-autosuggestions.git
synced 2024-11-18 09:51:06 +01:00
Pull out separate doc for installation instructions
This commit is contained in:
Eric Freese
parent
c113e49fe2
commit
72ccee33b4
2 changed files with 70 additions and 66 deletions
67
INSTALL.md
Normal file
67
INSTALL.md
Normal file
|
|
@ -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.
|
||||||
|
|
||||||
69
README.md
69
README.md
|
|
@ -4,6 +4,8 @@ _[Fish](http://fishshell.com/)-like fast/unobtrusive autosuggestions for zsh._
|
||||||
|
|
||||||
It suggests commands as you type, based on command history.
|
It suggests commands as you type, based on command history.
|
||||||
|
|
||||||
|
Requirements: Zsh v4.3.11 or later
|
||||||
|
|
||||||
[](https://circleci.com/gh/zsh-users/zsh-autosuggestions)
|
[](https://circleci.com/gh/zsh-users/zsh-autosuggestions)
|
||||||
|
|
||||||
<a href="https://asciinema.org/a/37390" target="_blank"><img src="https://asciinema.org/a/37390.png" width="400" /></a>
|
<a href="https://asciinema.org/a/37390" target="_blank"><img src="https://asciinema.org/a/37390.png" width="400" /></a>
|
||||||
|
|
@ -11,73 +13,8 @@ It suggests commands as you type, based on command history.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Requirements: Zsh v4.3.11 or later
|
See [INSTALL.md](INSTALL.md).
|
||||||
|
|
||||||
### Manual
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue