summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
index 97a368f..5d3a4a0 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,30 @@
+vim-preseed
+===========
A filetype plugin for [vim][] to add syntax highlighting to Debian [preseed][]
files.
+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-preseed
+
+It might be possible to use a plugin manager of some sorts. Some quirks are in
+the [Frequently Asked Questions](FAQ.md).
+
+About
+-----
+Vim v9.0 on debian 12 bookworm and v7.3 on FreeDOS 1.3 are tested. That means
+it is known be usable with at least the contemporary stable release of its
+primarily targeted environment, as well as a more than decade old release on an
+today rather fringe platform. Hopefully that equates to everywhere reasonable.
+
This plugin seems to work for me. Yet this is my first attempt at publishing a
vim plugin. I am fully aware the pattern matching should be possible to do more
cleanly. One could also imagine wishing to use the WarningMsg group, and place
@@ -8,6 +32,8 @@ known broken syntax (such as leading spaces in values) in it. It is unlikely to
be any further feature development on this by me, but my aim is to maintain the
code. 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.