b2f51a1a0a6dd2cb2baeb3e1131b5d41ee03a66d

Author
Jeffrey Chandler <36927673+jeff-chandler@users.noreply.github.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

command-not-found: add README (#7272)

Diff

 1diff --git a/plugins/command-not-found/README.md b/plugins/command-not-found/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..df62d1f075f35c97105990bba0e7c5627199d8c0
 4--- /dev/null
 5+++ b/plugins/command-not-found/README.md
 6@@ -0,0 +1,31 @@
 7+# command-not-found plugin
 8+
 9+This plugin uses the command-not-found package for zsh to provide suggested packages to be installed if a command cannot be found.
10+
11+To use it, add `command-not-found` to the plugins array of your zshrc file:
12+
13+```zsh
14+plugins=(... command-not-found)
15+```
16+
17+An example of how this plugin works in Ubuntu:
18+```
19+$ mutt
20+The program 'mutt' can be found in the following packages:
21+ * mutt
22+ * mutt-kz
23+ * mutt-patched
24+Try: sudo apt install <selected package>
25+```
26+
27+### Supported platforms
28+
29+It works out of the box with the command-not-found packages for:
30+
31+- [Ubuntu](https://www.porcheron.info/command-not-found-for-zsh/)
32+- [Debian](https://packages.debian.org/search?keywords=command-not-found)
33+- [Arch Linux](https://wiki.archlinux.org/index.php/Pkgfile#Command_not_found)
34+- [macOS (Homebrew)](https://github.com/Homebrew/homebrew-command-not-found)
35+- [Fedora](https://fedoraproject.org/wiki/Features/PackageKitCommandNotFound)
36+
37+You can add support for other platforms by submitting a Pull Request.