Archives/distant
2
0
Fork 0
mirror of https://github.com/chipsenkbeil/distant.git synced 2024-11-05 12:00:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add disclaimer about where the lua module needs to be placed

Browse Source
This commit is contained in:
Chip Senkbeil 2021-10-07 00:48:35 -05:00
parent 349c5382eb
commit 62e152c499
No known key found for this signature in database
GPG Key ID: 35EF1F8EC72A4131
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
distant-lua/README.md
View File

@ -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")