Readme changes

This commit is contained in:
XeroOl 2024-02-19 22:56:00 -06:00
parent 6152bed8a6
commit 7e1bde8d64

View File

@ -33,12 +33,10 @@ For Emacs, (eglot, built-in to 29+):
```
It should be possible to set up for other text editors, but the instructions depend on which editor you use.
Generally this involves somehow configuring this information:
* "fennel-ls" is a language server program on the path
Generally you need to give this information to your editor:
* "fennel-ls" is a language server program on the $PATH
* it should be run for .fnl files.
If you get it working in any other environments, I'd love to know! It would be great to have instructions on how to set up other editors!
## Batch mode
You can gather diagnostics without connecting your editor:
@ -47,6 +45,8 @@ You can gather diagnostics without connecting your editor:
fennel-ls --check my-file.fnl f2.fnl # prints diagnostics for the files given
```
This will analyze the given files, and print out all compiler errors and lints.
# Default Settings
fennel-ls can be configured over LSP. Any setting that's not provided will be filled in with the defaults, which means that `{}` will be a valid configuration with default settings. You can provide different settings in the same shape as the default settings in order to override the defaults.