From 2c71c403d4e0e1d7c92a4326ed891bc9966c7a14 Mon Sep 17 00:00:00 2001 From: Phil Hagelberg Date: Sun, 2 Mar 2025 08:41:37 -0800 Subject: [PATCH] Remove outdated mentions to love2d and link to vs-code extension. --- docs/docsets.md | 7 +++++-- docs/installation.md | 11 ++++++----- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/docsets.md b/docs/docsets.md index 5fb1448..be8ebb0 100644 --- a/docs/docsets.md +++ b/docs/docsets.md @@ -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 diff --git a/docs/installation.md b/docs/installation.md index 825ad17..5b31fae 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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