fennel-ls/README.md
Michele Campeotto c993f83595 Added a quick start section to the configuration manual
I received feedback that the info on setting up libraries is a little
buried in all the other details.

Pulling it up, it's likely going to be the first and most frequent
configuration people will want to change.
2025-03-04 08:44:19 -08:00

26 lines
1.3 KiB
Markdown

# fennel-ls
[Source](https://git.sr.ht/~xerool/fennel-ls) | [Issues](https://todo.sr.ht/~xerool/fennel-ls) | [Mailing List](https://lists.sr.ht/~xerool/fennel-ls)
Provides intelligent editing features for fennel files.
## Quick Links
* [Install](docs/installation.md)
* [Configuration](docs/manual.md)
* [Packaging](docs/packaging.md)
* [Writing your own lint](docs/linting.md)
For information about installing documentation data for 3rd-party libraries
like love2d or tic80 [see the wiki](https://wiki.fennel-lang.org/LanguageServer).
## License
fennel-ls is licensed under the MIT license. See LICENSE for more info.
This repository also contains files from other projects:
* `fennel` and `deps/fennel.lua` are compiled from [fennel](https://git.sr.ht/~technomancy/fennel) [MIT license]
* `deps/dkjson.lua` is from [dkjson](http://dkolf.de/dkjson-lua/) [MIT license]
* `deps/faith.lua` is from [faith](https://git.sr.ht/~technomancy/faith) [MIT license] (test only)
* `deps/pl/stringio.lua` is from [Penlight](https://github.com/lunarmodules/Penlight) [MIT license] (test only)
* `src/fennel-ls/docs/generated/*` contains files generated from other sources. It contains information from:
* the [lua](https://lua.org) reference [MIT license]
* [TIC80's "learn" webpage](https://tic80.com/learn) [MIT license]