Browse Source

cabal: add README (#7367)

Akash Krishnan 5 years ago
parent
commit
e83a4c8184
1 changed files with 9 additions and 0 deletions
  1. 9 0
      plugins/cabal/README.md

+ 9 - 0
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)
+```