xinb
/
zsh-completions
mirror of https://github.com/zsh-users/zsh-completions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

README improvements/fixes

This commit is contained in:
Julien Nicoulaud 2016-11-26 18:16:54 +01:00
parent 4c93cb02ec
commit 50cb5d1196
No known key found for this signature in database
GPG Key ID: D713C40AA20BF77D
1 changed files with 31 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
README.md
View File

@ -1,34 +1,46 @@
zsh-completions zsh-completions ![GitHub release](https://img.shields.io/github/release/zsh-users/zsh-completions.svg) ![GitHub contributors](https://img.shields.io/github/contributors/zsh-users/zsh-completions.svg) ![IRC](https://img.shields.io/badge/IRC-%23zsh--completions-yellow.svg)
=============== =============
**Additional completion definitions for [Zsh](http://www.zsh.org).** **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. 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 ### Using packages
* Arch Linux: [community/zsh-completions](https://www.archlinux.org/packages/zsh-completions) / [AUR/zsh-completions-git](https://aur.archlinux.org/packages/zsh-completions-git/) | System | Package |
* [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 ! |
* 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 ! |
* 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 frameworks ### Using zsh frameworks
* 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. #### [antigen](https://github.com/zsh-users/antigen)
Add `antigen bundle zsh-users/zsh-completions` to your `~/.zshrc`.
#### Manual installation #### [oh-my-zsh](http://github.com/robbyrussell/oh-my-zsh)
* Clone the repository inside your oh-my-zsh repo:
git clone https://github.com/zsh-users/zsh-completions ~/.oh-my-zsh/custom/plugins/zsh-completions
* 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
* Clone the repository: * Clone the repository:
@ -42,25 +54,7 @@ Usage
rm -f ~/.zcompdump; compinit rm -f ~/.zcompdump; compinit
#### oh-my-zsh ### Contributing
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
------------
Contributions are welcome, just make sure you follow the guidelines: 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. * Send a pull request or ask for committer access.
License ## License
-------
See each file for license details. See each file for license details.