fey.naomi/fennel-ls
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

A few more documentation tweaks.

Browse Source
This commit is contained in:
Phil Hagelberg 2025-03-04 08:56:49 -08:00
parent c993f83595
commit f2f661cc73
3 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/docsets.md
View File

@ -60,7 +60,8 @@ a, b radiuses and color with its center at x, y.
```
- `binding` is the full name of the symbol, so if this symbol is part of a
module the name should be in the form `module.symbol`
module the name should be in the form `module.symbol`; if it doesn't
have a dot in it then it's interpreted as a global.
- `fls/itemKind` describes the kind of this symbol, it can be any one of the
[CompletionItemKind](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#completionItemKind)
@ -118,7 +119,7 @@ and adding them to [the wiki](http://wiki.fennel-lang.org/LanguageServer)
if they are likely to be useful to other Fennel developers.
```sh
fennel library-docset.fnl > library-docset.lua
fennel --compile library-docset.fnl > library-docset.lua
cp library-docset.lua $HOME/.local/share/fennel-ls/docsets/
```

6
docs/installation.md
View File

@ -2,7 +2,7 @@
## Manual installation
To install from source on Linux or macOS, run:
To install from source on a unix system that has Lua installed:
```sh
$ git clone https://git.sr.ht/~xerool/fennel-ls
@ -10,15 +10,13 @@ $ cd fennel-ls
$ make
```
The only dependency is a Lua installation.
This build will create a `fennel-ls` executable for you using your default
system `lua`; use `make LUA=luajit` etc to use a different Lua version.
Run `make install PREFIX=$HOME` to put it in `~/bin` or `sudo make install` for
a system wide install.
You may want to also install [docsets](docsets) for external libraries.
You may want to also install [docsets](docsets.md) for external libraries.
## Packages

4
docs/manual.md
View File

@ -75,12 +75,12 @@ to indicate where the project root is located.
- `libraries`: This setting controls which extra documentation fennel-ls will
load in your environment. Each entry in the table is the name of the library
and a boolean, `true` to enable the library and `false` to disable it.
and a boolean, `true` to enable the library.
The name of the library is the name of a file that will be loaded from
`~/.local/share/fennel-ls/docsets/` after appending the `.lua` extension.
For example, if the table contains `{:love2d true}` the file `love2s.lua`
For example, if the table contains `{:love2d true}` the file `love2d.lua`
will be loaded from `~/.local/share/fennel-ls/docsets/`.
The available docsets are listed on the [Fennel