summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authorAkash Krishnan <akashfoss@users.noreply.github.com>2018-10-30 02:41:02 +0530
committerMarc Cornellà <marc.cornella@live.com>2018-10-29 22:11:02 +0100
commite83a4c81845885f378843cb0e9726592d964aafe (patch)
tree5026d5a293566ff81e6d993de54d4a9f37e87739 /plugins
parentdc3a605ec1cd7fb2476074ce47f74b0b5093ab46 (diff)
downloadzsh-e83a4c81845885f378843cb0e9726592d964aafe.tar.gz
zsh-e83a4c81845885f378843cb0e9726592d964aafe.tar.bz2
zsh-e83a4c81845885f378843cb0e9726592d964aafe.zip
cabal: add README (#7367)
Diffstat (limited to 'plugins')
-rw-r--r--plugins/cabal/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/plugins/cabal/README.md b/plugins/cabal/README.md
new file mode 100644
index 000000000..b1106c40f
--- /dev/null
+++ b/plugins/cabal/README.md
@@ -0,0 +1,9 @@
+# Cabal
+
+This plugin provides completion for [Cabal](https://www.haskell.org/cabal/), a build tool for Haskell. It
+also provides a function `cabal_sandbox_info` that prints whether the current working directory is in a sandbox.
+
+To use it, add cabal to the plugins array of your zshrc file:
+```
+plugins=(... cabal)
+```