From 62e152c4999d615c0e2772ead6a0906f66e7e64a Mon Sep 17 00:00:00 2001 From: Chip Senkbeil Date: Thu, 7 Oct 2021 00:48:35 -0500 Subject: [PATCH] Add disclaimer about where the lua module needs to be placed --- distant-lua/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/distant-lua/README.md b/distant-lua/README.md index 0e309d1..7dd4d5a 100644 --- a/distant-lua/README.md +++ b/distant-lua/README.md @@ -20,7 +20,10 @@ cargo build --release ## Examples Rename `libdistant_lua.so` or `libdistant_lua.dylib` to `distant_lua.so` -(yes, **.so** for **.dylib**) and place the library in your Lua path. +(yes, **.so** for **.dylib**) and place the library in your Lua path at +the *root*. The library cannot be within any submodule otherwise it fails +to load appropriate symbols. For neovim, this means directly within the +`lua/` directory. ```lua local distant = require("distant_lua")