aboutsummaryrefslogtreecommitdiffstats
path: root/bundle/mpvim/README
diff options
context:
space:
mode:
authorTeddy Wing2021-09-05 18:49:09 +0200
committerTeddy Wing2021-09-05 19:34:24 +0200
commit696766cc8d9ab129274347a185951a474337ea77 (patch)
tree389ff6e74d9f600efb504a2b3200c6020ff95677 /bundle/mpvim/README
parent25e5e7a7f759d0132b2d304299c0e3388e223e2d (diff)
downloaddotvim-696766cc8d9ab129274347a185951a474337ea77.tar.bz2
Add 'mpvim' plugin @ 513c455d5a902fff2b38edf86abc15c36688bf85
Provides syntax highlighting for MacPorts Portfiles. This code was copied from the 'macports-contrib' repository (https://github.com/macports/macports-contrib) at commit 513c455d5a902fff2b38edf86abc15c36688bf85 (https://github.com/macports/macports-contrib/tree/513c455d5a902fff2b38edf86abc15c36688bf85). The Vim plugin lives in a subdirectory of the 'macports-contrib' repository, so I'd have to include a whole mess of files that don't relate to Vim if I wanted to add the plugin as a submodule. I'd just as soon not have to copy the files into my repository tree like this, but it's better than adding a non-Vim submodule. Assuming it's okay to add these files to my repository, as the port file for this plugin describes it as being BSD licensed: https://github.com/macports/macports-ports/blob/12d7b1597bef875058758c9c587b7593f39a5af1/editors/mpvim/Portfile Unfortunately, there's no BSD license or copyright notice included in the plugin code. But I'm going to assume I'm allowed to redistribute it.
Diffstat (limited to 'bundle/mpvim/README')
-rw-r--r--bundle/mpvim/README26
1 files changed, 26 insertions, 0 deletions
diff --git a/bundle/mpvim/README b/bundle/mpvim/README
new file mode 100644
index 0000000..da7f6ca
--- /dev/null
+++ b/bundle/mpvim/README
@@ -0,0 +1,26 @@
+=== About mpvim
+mpvim adds MacPorts support to vim. This currently includes syntax coloring for
+Portfiles and running lint from vim.
+
+=== Manual installation
+Run 'make install' or copy the files in this directory into ~/.vim.
+
+=== Installation via MacPorts
+Run 'sudo port install mpvim'; the files will be placed into
+share/vim/vimfiles under the MacPorts prefix (/opt/local by default).
+
+=== Usage
+* :make runs 'port lint' on the Portfile in the current buffer
+
+* :MPpatch <url> applies the patch located at <url> to the Portfile
+ in the current buffer and shows the differences with vimdiff. Also
+ automatically fetches the patch format in case the diff is on trac.
+
+* add 'let g:portfile_highlight_space_errors=1' to your .vimrc to highlight mixed
+ spaces and tabs in Portfiles as errors
+
+* mpvim supports snipMate (http://www.vim.org/scripts/script.php?script_id=2540)
+ snippets. "new<Tab>" in a new buffer named Portfile will create a new
+ Portfile skeleton. Subsequent <Tab>'s will cycle through the variables.
+ More snippets are available for variants, build phases etc. Take a look
+ at snippets/portfile.vim for the complete list