andr3/zls
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #598 from Techatrix/update-readme

Browse Source 
update README.md
This commit is contained in:
Lee Cannon 2022-08-22 17:34:07 +01:00 committed by GitHub
commit 691502102d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -70,7 +70,7 @@ Building `zls` is very easy. You will need [a build of Zig master](https://zigla
git clone --recurse-submodules https://github.com/zigtools/zls git clone --recurse-submodules https://github.com/zigtools/zls
cd zls cd zls
zig build -Drelease-safe zig build -Drelease-safe
./zig-out/bin/zls config # Configure ZLS ./zig-out/bin/zls --config # Configure ZLS
``` ```
*For detailed building instructions, see the Wiki page about [Cloning With Git](https://github.com/zigtools/zls/wiki/Downloading-and-Building-ZLS#cloning-with-git).* *For detailed building instructions, see the Wiki page about [Cloning With Git](https://github.com/zigtools/zls/wiki/Downloading-and-Building-ZLS#cloning-with-git).*
@ -92,7 +92,7 @@ There is also a `generate-data.js` in the `src/data` folder, you'll need to run
### Configuration Options ### Configuration Options
You can configure zls by running `zls config` or manually creating your own `zls.json` configuration file. You can configure zls by running `zls --config` or manually creating your own `zls.json` configuration file.
zls will look for a zls.json configuration file in multiple locations with the following priority: zls will look for a zls.json configuration file in multiple locations with the following priority:
- In the local configuration folder of your OS (as provided by [known-folders](https://github.com/ziglibs/known-folders/blob/master/RESOURCES.md#folder-list)) - In the local configuration folder of your OS (as provided by [known-folders](https://github.com/ziglibs/known-folders/blob/master/RESOURCES.md#folder-list))
- In the global configuration folder of your OS (as provided by [known-folders](https://github.com/ziglibs/known-folders/blob/master/RESOURCES.md#folder-list)) - In the global configuration folder of your OS (as provided by [known-folders](https://github.com/ziglibs/known-folders/blob/master/RESOURCES.md#folder-list))
@ -118,8 +118,8 @@ The following options are currently available.
## Features ## Features
`zls` supports most language features, including simple type function support, using namespace, payload capture type resolution, custom packages and others. `zls` supports most language features, including simple type function support, using namespace, payload capture type resolution, custom packages, `cImport` and others.
Notable language features that are not currently implemented include `@cImport` as well as most forms of compile time evaluation. Currently there is no support for compile time evaluation.
The following LSP features are supported: The following LSP features are supported:
- Completions - Completions