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

Remove outdated mentions to love2d and link to vs-code extension.

Browse Source
This commit is contained in:
Phil Hagelberg 2025-03-02 08:41:37 -08:00
parent 1f123c6baa
commit 2c71c403d4
2 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/docsets.md
View File

@ -35,7 +35,8 @@ available.
## Creating docsets
The top level Lua table in the docset should contain symbol names as keys and
*bindings* as values.
*bindings* as values. These examples use Fennel syntax, so they should
be compiled to Lua before installation or distribution.
```fnl
{:symbol-a {
@ -112,7 +113,9 @@ script and then serializing it using the `fennel.view` function.
## Compilation
Finally, to be usable by fennel-ls the table needs to be compiled to Lua and
installed in the docsets directory.
installed in the docsets directory. Consider publishing them over HTTP
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

11
docs/installation.md
View File

@ -7,7 +7,6 @@ To install from source on Linux or macOS, run:
```sh
$ git clone https://git.sr.ht/~xerool/fennel-ls
$ cd fennel-ls
$ make docs-love2d # if you plan to use love2d
$ make
```
@ -19,10 +18,7 @@ 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.
The default build will not include documentation for [LÖVE](https://love2d.org)
due to the unfortunate licensing of their documentation. You can opt-in to
build with these docs anyway with `make docs-love2d` but the resulting build
may have legal complications when distributed.
You may want to also install [docsets](docsets) for external libraries.
## Packages
@ -108,6 +104,11 @@ If you run into problems, check the [LSP Client Configuration
reference](https://lsp.sublimetext.io/client_configuration/) and double-check
the location of fennel-ls on the $PATH is visible to Sublime Text.
### Visual Studio Code
You need to [install an extension](https://codeberg.org/adjuvant/vscode-fennel-ls)
in order to use it.
### Other editors
It should be possible to set up for other text editors, but the instructions