1
1
mirror of https://github.com/tweag/nickel.git synced 2024-10-26 11:52:13 +03:00

Fix binary name of nls, update doc

This commit is contained in:
Yann Hamdaoui 2022-03-12 10:03:26 +01:00
parent 46fc4ea6aa
commit ad581b791e
2 changed files with 14 additions and 6 deletions

View File

@ -58,16 +58,20 @@ nix-env -f . -i
### Using Cargo
If you already have a working [`cargo`](https://doc.rust-lang.org/cargo/) installation, you can make `nls` available
globally (it will be built and stored inside the repository) without
Nix:
If you already have a working [`cargo`](https://doc.rust-lang.org/cargo/)
installation, you can make `nls` available globally without Nix:
```
git clone https://github.com/tweag/nickel.git
cd nickel/lsp/nls
cargo install --path .
cargo install nickel-lang-lsp
```
**WARNING**: the 0.1.0 version of the NLS crate
([nickel-lang-lsp](https://crates.io/crates/nickel-lang-lsp)) doesn't
correctly define the name of the binary as `nls`. If you can't find `nls` after
a successful cargo installation, try to run `nickel-lang-lsp --version`. If this
command is available, you'll have to substitute `nls` for `nickel-lang-lsp` in
the instructions that follow.
## Interfacing with editors
Once the `nls` binary is available, you can proceed with the configuration of

View File

@ -9,6 +9,10 @@ repository = "https://github.com/tweag/nickel"
keywords = ["nickel", "configuration", "language", "lsp"]
edition = "2018"
[[bin]]
name = "nls"
path = "src/main.rs"
[build-dependencies]
lalrpop = "0.19.6"