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

Explain that love2d support is opt-in for licensing reasons.

Browse Source 
Booooooooo GFDL.

Also include a link to apt.technomancy.us.
This commit is contained in:
Phil Hagelberg 2025-02-15 09:51:21 -08:00
parent 54c3d5c6c3
commit 6cddd6a030
3 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Makefile
View File

@ -31,6 +31,9 @@ repl:
docs: docs:
$(FENNEL) $(FENNELFLAGS) tools/get-docs.fnl $(GET_DOCS_FLAGS) $(FENNEL) $(FENNELFLAGS) tools/get-docs.fnl $(GET_DOCS_FLAGS)
docs-love2d:
$(FENNEL) $(FENNELFLAGS) tools/get-docs.fnl --generate-love2d
rm-docs: rm-docs:
rm -rf src/fennel-ls/docs/ rm -rf src/fennel-ls/docs/

18
docs/manual.md
View File

@ -9,6 +9,7 @@ On Linux or Mac OS,
```sh ```sh
$ git clone https://git.sr.ht/~xerool/fennel-ls $ git clone https://git.sr.ht/~xerool/fennel-ls
$ cd fennel-ls $ cd fennel-ls
$ make docs-love2d # if you plan to use love2d
$ make $ make
``` ```
will create a bleeding-edge latest git `fennel-ls` binary for you. will create a bleeding-edge latest git `fennel-ls` binary for you.
@ -16,16 +17,27 @@ will create a bleeding-edge latest git `fennel-ls` binary for you.
Run `make install PREFIX=$HOME` to put it in `~/bin` or `sudo make install` for Run `make install PREFIX=$HOME` to put it in `~/bin` or `sudo make install` for
a systemwide install. a systemwide 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.
#### Arch Linux #### Arch Linux
I think `fennel-ls` and `fennel-ls-git` may be in the AUR. I think `fennel-ls` and `fennel-ls-git` may be in the AUR.
#### NixOS
If you are using NixOS, you can use the included `/flake.nix` or `/default.nix`.
#### Debian/Ubuntu
Unofficial `.deb` packages are available at
[https://apt.technomancy.us](https://apt.technomancy.us).
#### Luarocks #### Luarocks
Alternatively, `fennel-ls` is available in LuaRocks. Luarocks is kind of a pain to support though. Alternatively, `fennel-ls` is available in LuaRocks. Luarocks is kind of a pain to support though.
```sh ```sh
luarocks install fennel-ls luarocks install fennel-ls
``` ```
#### NixOS
If you are using NixOS, you can use the included `/flake.nix` or `/default.nix`.
### Emacs ### Emacs
prerequisites: You have installed the [fennel-ls binary](#fennel-ls-language-server-binary). prerequisites: You have installed the [fennel-ls binary](#fennel-ls-language-server-binary).
@ -91,7 +103,7 @@ The default `flsproject.fnl` settings are:
{:fennel-path "./?.fnl;./?/init.fnl;src/?.fnl;src/?/init.fnl" {:fennel-path "./?.fnl;./?/init.fnl;src/?.fnl;src/?/init.fnl"
:macro-path "./?.fnl;./?/init-macros.fnl;./?/init.fnl;src/?.fnl;src/?/init-macros.fnl;src/?/init.fnl" :macro-path "./?.fnl;./?/init-macros.fnl;./?/init.fnl;src/?.fnl;src/?/init-macros.fnl;src/?/init.fnl"
:lua-version "lua54" :lua-version "lua54"
:libraries {:love2d false :libraries {:love2d false ; requires building with love2d support
:tic-80 false} :tic-80 false}
:extra-globals "" :extra-globals ""
:lints {:unused-definition true :lints {:unused-definition true

1
tools/get-docs.fnl
View File

@ -23,6 +23,7 @@
(convert (with-open [file (curl-cached url)] (convert (with-open [file (curl-cached url)]
(file:read :*a))))) (file:read :*a)))))
;; a lot of this should maybe be moved to the makefile?
(fn main [] (fn main []
(sh :mkdir :-p "build/") (sh :mkdir :-p "build/")
(sh :mkdir :-p "src/fennel-ls/docs/generated/") (sh :mkdir :-p "src/fennel-ls/docs/generated/")