aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJulien Nicoulaud <julien.nicoulaud@gmail.com>2011-07-31 20:04:09 +0200
committerJulien Nicoulaud <julien.nicoulaud@gmail.com>2011-07-31 20:04:09 +0200
commitca2a55d7375316dc4863f1bf7de528dba8914c56 (patch)
tree822cd81ff9545d1bac281c36711f83ac388642ff /README.md
parentAck: complete --type-set with the extensions of the files in cwd (diff)
downloadzsh-completions-ca2a55d7375316dc4863f1bf7de528dba8914c56.tar
zsh-completions-ca2a55d7375316dc4863f1bf7de528dba8914c56.tar.gz
zsh-completions-ca2a55d7375316dc4863f1bf7de528dba8914c56.tar.bz2
zsh-completions-ca2a55d7375316dc4863f1bf7de528dba8914c56.tar.lz
zsh-completions-ca2a55d7375316dc4863f1bf7de528dba8914c56.tar.xz
zsh-completions-ca2a55d7375316dc4863f1bf7de528dba8914c56.tar.zst
zsh-completions-ca2a55d7375316dc4863f1bf7de528dba8914c56.zip
Improve README
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 17 insertions, 4 deletions
diff --git a/README.md b/README.md
index fe0d339..e4b87ee 100644
--- a/README.md
+++ b/README.md
@@ -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,10 +13,23 @@ 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
- fpath=(path/to/zsh-completions $fpath)
+ 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