Skip to content

Commit

Permalink
docs: Split README.md into INSTALL.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
danielshahaf committed Nov 24, 2015
1 parent 8e11505 commit 0b3183f
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 63 deletions.
69 changes: 69 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
How to install
--------------

### Using packages

* Arch Linux: [community/zsh-syntax-highlighting][arch-package] / [AUR/zsh-syntax-highlighting-git][AUR-package]
* Gentoo: [mv overlay][gentoo-overlay]
* Mac OS X / Homebrew: [brew install zsh-syntax-highlighting][brew-package]

[arch-package]: https://www.archlinux.org/packages/zsh-syntax-highlighting
[AUR-package]: https://aur.archlinux.org/packages/zsh-syntax-highlighting-git
[gentoo-overlay]: http://gpo.zugaina.org/app-shells/zsh-syntax-highlighting
[brew-package]: https://github.com/Homebrew/homebrew/blob/master/Library/Formula/zsh-syntax-highlighting.rb


### In your ~/.zshrc

* Clone this repository:

git clone git://github.com/zsh-users/zsh-syntax-highlighting.git

If `git` is not installed, you could download a snapshot of the latest
development tree from:

https://github.com/zsh-users/zsh-syntax-highlighting/archive/master.tar.gz

* Source the script **at the end** of `~/.zshrc`:

source /path/to/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh

* Source `~/.zshrc` to take changes into account:

source ~/.zshrc


### With oh-my-zsh

Oh-my-zsh is a zsh configuration framework. It lives at
<http://github.com/robbyrussell/oh-my-zsh>.

To install zsh-syntax-highlighting under oh-my-zsh:

1. Clone this repository in oh-my-zsh's plugins directory:

git clone git://github.com/zsh-users/zsh-syntax-highlighting.git ~/.oh-my-zsh/custom/plugins/zsh-syntax-highlighting

2. Activate the plugin in `~/.zshrc`:

plugins=( [plugins...] zsh-syntax-highlighting)

3. Source `~/.zshrc` to take changes into account:

source ~/.zshrc

Note that `zsh-syntax-highlighting` must be the last plugin sourced,
so make it the last element of the `$plugins` array.


### System-wide installation

Either of the above methods is suitable for a single-user installation,
which requires no special privileges. If, however, you desire to install
zsh-syntax-highlighting system-wide, you may do so by running `make install`
and directing your users to add
`source /usr/local/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh`
in their `.zshrc`s.



64 changes: 1 addition & 63 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,69 +19,7 @@ them, particularly in catching syntax errors.
How to install
--------------

### Using packages

* Arch Linux: [community/zsh-syntax-highlighting][arch-package] / [AUR/zsh-syntax-highlighting-git][AUR-package]
* Gentoo: [mv overlay][gentoo-overlay]
* Mac OS X / Homebrew: [brew install zsh-syntax-highlighting][brew-package]

[arch-package]: https://www.archlinux.org/packages/zsh-syntax-highlighting
[AUR-package]: https://aur.archlinux.org/packages/zsh-syntax-highlighting-git
[gentoo-overlay]: http://gpo.zugaina.org/app-shells/zsh-syntax-highlighting
[brew-package]: https://github.com/Homebrew/homebrew/blob/master/Library/Formula/zsh-syntax-highlighting.rb


### In your ~/.zshrc

* Clone this repository:

git clone git://github.com/zsh-users/zsh-syntax-highlighting.git

If `git` is not installed, you could download a snapshot of the latest
development tree from:

https://github.com/zsh-users/zsh-syntax-highlighting/archive/master.tar.gz

* Source the script **at the end** of `~/.zshrc`:

source /path/to/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh

* Source `~/.zshrc` to take changes into account:

source ~/.zshrc


### With oh-my-zsh

Oh-my-zsh is a zsh configuration framework. It lives at
<http://github.com/robbyrussell/oh-my-zsh>.

To install zsh-syntax-highlighting under oh-my-zsh:

1. Clone this repository in oh-my-zsh's plugins directory:

git clone git://github.com/zsh-users/zsh-syntax-highlighting.git ~/.oh-my-zsh/custom/plugins/zsh-syntax-highlighting

2. Activate the plugin in `~/.zshrc`:

plugins=( [plugins...] zsh-syntax-highlighting)

3. Source `~/.zshrc` to take changes into account:

source ~/.zshrc

Note that `zsh-syntax-highlighting` must be the last plugin sourced,
so make it the last element of the `$plugins` array.


### System-wide installation

Either of the above methods is suitable for a single-user installation,
which requires no special privileges. If, however, you desire to install
zsh-syntax-highlighting system-wide, you may do so by running `make install`
and directing your users to add
`source /usr/local/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh`
in their `.zshrc`s.
See [INSTALL.md](INSTALL.md).


FAQ
Expand Down

0 comments on commit 0b3183f

Please sign in to comment.