Skip to content

Commit

Permalink
Add disclaimer about where the lua module needs to be placed
Browse files Browse the repository at this point in the history
  • Loading branch information
chipsenkbeil committed Oct 7, 2021
1 parent 349c538 commit 62e152c
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion distant-lua/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down

0 comments on commit 62e152c

Please sign in to comment.