Merge branch 'patch-3' of https://github.com/larryhynes/vis

1 files changed, 24 insertions, 0 deletions

diff --git a/README.md b/README.md
index f0a5821..1257fa6 100644
--- a/README.md
+++ b/README.md
@@ -440,6 +440,30 @@ Operators can be forced to work line wise by specifying `V`.
     :e *.c          # opens a menu with all C files
     :e .            # opens a menu with all files of the current directory
 
+### Configuring vis: visrc.lua, and environment variables
+
+Settings and keymaps can be specified in a `visrc.lua` file, which will
+be read by `vis` at runtime. An example `visrc.lua` file is installed
+in `/usr/local/share/vis` by default. This file can be copied to
+`$XDG_CONFIG_HOME/vis` (which defaults to `$HOME/.config/vis`) for
+further configuration.
+
+The environment variable `VIS_PATH` can be set to override the path
+that `vis` will look for Lua support files as used for syntax
+highlighting. `VIS_PATH` defaults (in this order) to
+
+- The location of the `vis` binary
+- `$XDG_CONFIG_HOME/vis`, where `$XDG_CONFIG_HOME` refers to
+`$HOME/.config` if unset
+- `/usr/local/share/vis`
+- `/usr/share/vis`
+
+The environment variable `VIS_THEME` can be set to specify the
+theme used by `vis` e.g.
+
+    VIS_THEME=/path/to/your/theme.lua
+    export VIS_THEME
+
 ### Runtime Configurable Key Bindings
 
 Vis supports run time key bindings via the `:{un,}map{,-window}` set of