From 003737c59668b6793d36fef4040318b999c153de Mon Sep 17 00:00:00 2001 From: Florian Fischer Date: Fri, 7 Apr 2017 13:06:36 +0200 Subject: add Readme and plugin --- Readme.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 Readme.md (limited to 'Readme.md') diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..344a6d9 --- /dev/null +++ b/Readme.md @@ -0,0 +1,22 @@ +# vis-spellcheck + +A spellchecking lua plugin for the [vis editor](https://github.com/martanne/vis). + +## installation + +1. Download 'spellcheck.lua' or clone this repository +2. Load the plugin in your 'visrc.lua' with 'require(path/to/plugin/spellcheck)' + +## usage + ++ To correct the whole file press Ctrl+s in normal mode. + +## configuration + +The module table returned from 'require(...)' has two configuration fields +'lang' and 'cmd'. 'lang' is inserted in the 'cmd' string at '%s'. +The defaults are 'enchant -d %s' and '$LANG or "en_US". + + spell = require(...) + spell.cmd = "aspell -l %s -a" + spell.lang = "en_US" -- cgit v1.2.3