vim: update and rename vim-essentials (standard), vim-gui (mouse)

[webi-installers/.git] / vim-essentials / README.md

diff --git a/vim-essentials/README.md b/vim-essentials/README.md
new file mode 100644 (file)
index 0000000..dc144ca
--- /dev/null
+++ b/vim-essentials/README.md
@@ -0,0 +1,34 @@
+---
+title: vim-essentials
+homepage: https://webinstall.dev/vim-essentials
+tagline: |
+  meta package for our recommended vim plugins and settings
+---
+
+To update (replacing the current version) run `webi vim-essentials`.
+
+## Cheat Sheet
+
+> A collection of extremely useful plugins and very simple one-line changes to
+> vim's default settings.
+
+This meta package will install the full set of plugins and settings we
+recommended.
+
+It includes many of the vim plugins available on webinstall.dev such as:
+
+- [vim-leader](/vim-leader)
+- [vim-shell](/vim-shell)
+- [vim-sensible](/vim-sensible)
+- [vim-viminfo](/vim-viminfo)
+- [vim-lastplace](/vim-lastplace)
+- [vim-spell](/vim-spell)
+- [vim-ale](/vim-ale)
+- [vim-prettier](/vim-prettier)
+- [vim-whitespace](/vim-whitespace)
+
+It **DOES NOT** include these, which you may also want:
+
+- [vim-gui](/vim-gui) (mouse and clipboard support)
+- [vim-nerdtree](/vim-nerdtree)
+- [vim-devicons](/vim-devicons)