diff options
| author | Julien Nicoulaud <julien.nicoulaud@gmail.com> | 2016-11-26 18:16:54 +0100 |
|---|---|---|
| committer | Julien Nicoulaud <julien.nicoulaud@gmail.com> | 2016-11-26 18:16:54 +0100 |
| commit | 50cb5d1196004c558d9975a4a0823e657c9c5212 (patch) | |
| tree | d144ea13d347089bf9a5d4447812701baf90e331 /README.md | |
| parent | Add completion script for Software Collections (https://www.softwarecollectio... (diff) | |
| download | zsh-completions-50cb5d1196004c558d9975a4a0823e657c9c5212.tar zsh-completions-50cb5d1196004c558d9975a4a0823e657c9c5212.tar.gz zsh-completions-50cb5d1196004c558d9975a4a0823e657c9c5212.tar.bz2 zsh-completions-50cb5d1196004c558d9975a4a0823e657c9c5212.tar.lz zsh-completions-50cb5d1196004c558d9975a4a0823e657c9c5212.tar.xz zsh-completions-50cb5d1196004c558d9975a4a0823e657c9c5212.tar.zst zsh-completions-50cb5d1196004c558d9975a4a0823e657c9c5212.zip | |
README improvements/fixes
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 69 |
1 files changed, 31 insertions, 38 deletions
@@ -1,34 +1,46 @@ -zsh-completions -=============== +zsh-completions    +============= **Additional completion definitions for [Zsh](http://www.zsh.org).** -*This projects aims at gathering/developing new completion scripts that are not available in Zsh yet. The scripts are meant to be contributed to the Zsh project when stable enough.* +*This projects aims at gathering/developing new completion scripts that are not available in Zsh yet. The scripts may be contributed to the Zsh project when stable enough.* -Status ------- +## Status + See [issues](https://github.com/zsh-users/zsh-completions/issues) for details on each completion definition. -Gentoo's completions have been removed, as they are maintained upstream. See: [Gentoo zsh-completions](https://github.com/radhermit/gentoo-zsh-completions) -Usage ------ +## Usage + +### Using packages + +| System | Package | +| ------------- | ------------- | +| Debian based distributions (Debian/Ubuntu/Linux Mint...) | Packager needed, please get in touch ! | +| RPM based distributions (Fedora/RHEL/CentOS...) | Packager needed, please get in touch ! | +| Arch Linux | [zsh-completions](https://www.archlinux.org/packages/zsh-completions), [zsh-completions-git](https://aur.archlinux.org/packages/zsh-completions-git) | +| Gentoo | [app-shells/zsh-completions](http://packages.gentoo.org/package/app-shells/zsh-completions) | +| Mac OS | [homebrew](https://github.com/Homebrew/homebrew-core/blob/master/Formula/zsh-completions.rb) | + +### Using zsh frameworks + +#### [antigen](https://github.com/zsh-users/antigen) + +Add `antigen bundle zsh-users/zsh-completions` to your `~/.zshrc`. -#### Using packages +#### [oh-my-zsh](http://github.com/robbyrussell/oh-my-zsh) -* Arch Linux: [community/zsh-completions](https://www.archlinux.org/packages/zsh-completions) / [AUR/zsh-completions-git](https://aur.archlinux.org/packages/zsh-completions-git/) -* [Gentoo](http://packages.gentoo.org/package/app-shells/zsh-completions) -* Mac OS: [Homebrew](https://github.com/Homebrew/homebrew-core/blob/master/Formula/zsh-completions.rb) -* Debian based distributions (Debian/Ubuntu/Linux Mint...): Packager needed, please get in touch ! -* RPM based distributions (Fedora/RHEL/CentOS...): Packager needed, please get in touch ! +* Clone the repository inside your oh-my-zsh repo: -#### Using frameworks + git clone https://github.com/zsh-users/zsh-completions ~/.oh-my-zsh/custom/plugins/zsh-completions -* If you're using [antigen](https://github.com/zsh-users/antigen), just add `antigen bundle zsh-users/zsh-completions` to your .zshrc where you're loading your other zsh plugins. +* Enable it in your `.zshrc` by adding it to your plugin list and reloading the completion: + plugins=(… zsh-completions) + autoload -U compinit && compinit -#### Manual installation +### Manual installation * Clone the repository: @@ -42,25 +54,7 @@ Usage rm -f ~/.zcompdump; compinit -#### oh-my-zsh - -If you use [oh-my-zsh][] then just clone the repository inside your oh-my-zsh repo: - -```Shell -git clone https://github.com/zsh-users/zsh-completions ~/.oh-my-zsh/custom/plugins/zsh-completions -``` - -and enable it in your `.zshrc` by adding it to your plugin list and reloading the completion: - -```zsh -plugins=(… zsh-completions) -autoload -U compinit && compinit -``` - -[oh-my-zsh]: http://github.com/robbyrussell/oh-my-zsh - -Contributing ------------- +### Contributing Contributions are welcome, just make sure you follow the guidelines: @@ -74,6 +68,5 @@ Contributions are welcome, just make sure you follow the guidelines: * Send a pull request or ask for committer access. -License -------- +## License See each file for license details. |