zsh-completions/README.md

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.*


Status
------
See [issues](https://github.com/zsh-users/zsh-completions/issues) for details on each completion definition.


Usage
-----

#### 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/)
* Gentoo: [scrill overlay](http://gpo.zugaina.org/app-shells/zsh-completions)
* Mac OS: [Homebrew](https://github.com/mxcl/homebrew/blob/master/Library/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 !


#### Manual installation

* Clone the repository:

        git clone git://github.com/zsh-users/zsh-completions.git

* Include the directory in your `$fpath`, for example by adding in `~/.zshrc`:

        fpath=(path/to/zsh-completions/src $fpath)

* You may have to force rebuild `zcompdump`:

        rm -f ~/.zcompdump; compinit

Contributing
------------

Contributions are welcome, just make sure you follow the guidelines:

 * Please add a header containing authors, license info, status and origin of the script (example [here](src/_ack)).
 * Please try to follow [Zsh completion style guide](https://github.com/zsh-users/zsh/blob/master/Etc/completion-style-guide).
 * Send a pull request or ask for committer access.


License
-------
See each file for license details.
Add README 2011-07-20 12:38:50 +00:00			`zsh-completions`
			`===============`

			`Additional completion definitions for [Zsh](http://www.zsh.org).`

Improve README 2011-07-31 18:04:09 +00:00			`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.`
Add README 2011-07-20 12:38:50 +00:00

			`Status`
			`------`
Fix issues relative link in README 2013-02-27 02:13:49 +00:00			`See [issues](https://github.com/zsh-users/zsh-completions/issues) for details on each completion definition.`
Add README 2011-07-20 12:38:50 +00:00

			`Usage`
			`-----`
Update README with ArchLinux AUR package and improve manual installation instructions. 2011-10-12 20:34:01 +00:00
			`#### Using packages`

Update README.md Edited links to Archlinux packages (the link to *-git is out-of-date, zsh-completion now available in [community]) 2014-01-09 00:35:16 +00:00			`* Arch Linux: [community/zsh-completions](https://www.archlinux.org/packages/zsh-completions) / [AUR/zsh-completions-git](https://aur.archlinux.org/packages/zsh-completions-git/)`
Add links to Arch Linux and Gentoo packages (Anyone knowing packages for other systems or wanting to create it, please get in touch!) 2011-12-03 18:50:36 +00:00			`* Gentoo: [scrill overlay](http://gpo.zugaina.org/app-shells/zsh-completions)`
Add link to Mac OS Homebrew package 2012-08-01 11:16:03 +00:00			`* Mac OS: [Homebrew](https://github.com/mxcl/homebrew/blob/master/Library/Formula/zsh-completions.rb)`
Add call for deb and rpm packagers 2012-08-01 11:21:33 +00:00			`* 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 !`
Add links to Arch Linux and Gentoo packages (Anyone knowing packages for other systems or wanting to create it, please get in touch!) 2011-12-03 18:50:36 +00:00
Update README with ArchLinux AUR package and improve manual installation instructions. 2011-10-12 20:34:01 +00:00
			`#### Manual installation`

Improve README 2011-07-31 18:04:09 +00:00			`* Clone the repository:`
Cosmetic changes 2011-07-21 22:35:27 +00:00
Improve README 2011-07-31 18:04:09 +00:00			`git clone git://github.com/zsh-users/zsh-completions.git`

Update README with ArchLinux AUR package and improve manual installation instructions. 2011-10-12 20:34:01 +00:00			* Include the directory in your `$fpath`, for example by adding in `~/.zshrc`:
Improve README 2011-07-31 18:04:09 +00:00
Fix README after 10ffeb0 2012-08-01 11:30:37 +00:00			`fpath=(path/to/zsh-completions/src $fpath)`
Improve README 2011-07-31 18:04:09 +00:00
Update README with ArchLinux AUR package and improve manual installation instructions. 2011-10-12 20:34:01 +00:00			* You may have to force rebuild `zcompdump`:

			`rm -f ~/.zcompdump; compinit`
Improve README 2011-07-31 18:04:09 +00:00
			`Contributing`
			`------------`

			`Contributions are welcome, just make sure you follow the guidelines:`

Fixed a broken link. _ack was not pointing to the right place, because it seems src/ was added after the README was written. Uses the new relative path syntax. 2013-02-07 00:55:37 +00:00			`* Please add a header containing authors, license info, status and origin of the script (example [here](src/_ack)).`
Improve README 2011-07-31 18:04:09 +00:00			`* Please try to follow [Zsh completion style guide](https://github.com/zsh-users/zsh/blob/master/Etc/completion-style-guide).`
			`* Send a pull request or ask for committer access.`
Add README 2011-07-20 12:38:50 +00:00

			`License`
			`-------`
			`See each file for license details.`
Add link to Mac OS Homebrew package 2012-08-01 11:16:03 +00:00