diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..e632a0b --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +vim-ipxe +======== +A filetype plugin for [vim][] to add syntax highlighting to [iPXE][] scripts. + +Install +------- +Use your preferred procedure, just as for installing any plugin. There should +be no special steps required. Please see ':help plugin' if unsure. + +Unless having any other preference, the simplest installation method is likely +to merely do something along the lines of: + + mkdir -p ~/.vim/pack/git-plugins/start/ || : + cd ~/.vim/pack/git-plugins/start/ + git clone https://git.netizen.se/vim-ipxe + +It might be possible to use a plugin manager of some sorts. Some quirks are in +the [Frequently Asked Questions](FAQ.md). + +About +----- +This plugin provides syntax highlighting. A handful of undocumented commands +exist. Syntax highlighting for those are missing. There are likely bugs too. +Patches are welcome, as is positive and constructive feedback. + +License +------- +Provided under MIT No Attribution License. Relicensing will be immediately done +on request, if needed for inclusion in the vim official source tree or as part +of its debian package. + +[vim]: https://www.vim.org/ +[iPXE]: https://ipxe.org/ |