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

Improve README

This commit is contained in:
Julien Nicoulaud 2011-07-31 20:04:09 +02:00
parent 54f6fa1db9
commit ca2a55d737
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -3,7 +3,7 @@ zsh-completions
**Additional completion definitions for [Zsh](http://www.zsh.org).**
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 are meant to be contributed to the Zsh project when stable enough.*
Status
@ -13,12 +13,25 @@ See [issues](zsh-completions/issues) for details on each completion definition.
Usage
-----
Drop the scripts in a directory included in your `$fpath`, for example:
* Clone the repository:
git clone git://github.com/zsh-users/zsh-completions.git
* Include the directory in your `$fpath`, for example:
fpath=(path/to/zsh-completions $fpath)
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](https://github.com/zsh-users/zsh-completions/blob/master/_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.