Skip to content

Commit 09f449e

Browse files
committed
Include instructions for cursor
1 parent 6397ee8 commit 09f449e

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

docs/installation.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The Lingua Franca toolchain requires Java 17 ([download from Oracle](https://www
88

99
You can use Lingua Franca:
1010

11-
- [in Visual Studio Code, using our extension](#visual-studio-code)
11+
- [in Visual Studio Code and compatible tools, using our extension](#visual-studio-code)
1212
- [using the command line](#cli-tools)
1313

1414
You can also spin up one of our pre-configured Cloud-based dev environments:
@@ -17,11 +17,11 @@ You can also spin up one of our pre-configured Cloud-based dev environments:
1717

1818
[![GH Codespace](https://github.com/codespaces/badge.svg)](<https://github.com/codespaces/new?hide_repo_select=true&repo=477928779&ref=main&skip_quickstart=true&devcontainer_path=.devcontainer%2Fnightly%2Fdevcontainer.json>)
1919

20-
Have a look at the [Lingua Franca playground](https://github.com/lf-lang/playground-lingua-franca) for more details.
20+
Have a look at the [Lingua Franca playground](https://github.com/lf-lang/playground-lingua-franca) for example programs and more details on the cloud-based dev environments.
2121

2222
## Visual Studio Code
2323

24-
Our Visual Studio Code extension can be installed via the Marketplace or built from source, as detailed below. See the [handbook](./tools/code-extension.mdx) for usage instructions.
24+
Our Visual Studio Code extension can be installed via the Marketplace or built from source, as detailed below. This extension also works with VS Code-compatible tools such as [Cursor](https://cursor.com). See the [handbook](./tools/code-extension.mdx) for usage instructions.
2525

2626
### Marketplace
2727

@@ -37,6 +37,13 @@ Alternatively, you can run the following command in your terminal:
3737
code --install-extension lf-lang.vscode-lingua-franca
3838
```
3939

40+
or
41+
42+
```
43+
cursor --install-extension lf-lang.vscode-lingua-franca
44+
```
45+
46+
4047
To use the nightly pre-release of the extension instead of the latest release, find the Lingua Franca extension in the Extensions tab and click on the "Switch to Pre-Release Version" button.
4148

4249
### From Source
@@ -56,6 +63,13 @@ Run the following command in your terminal to install the latest release (on Win
5663
curl -Ls https://install.lf-lang.org | bash -s cli
5764
```
5865

66+
If you get `permission denied`, your platform may require `sudo`, as follows:
67+
68+
```
69+
curl -Ls https://install.lf-lang.org | sudo bash -s cli
70+
```
71+
72+
5973
You can also install the nightly pre-release:
6074

6175
```
@@ -80,9 +94,7 @@ yay -S lf-cli-nightly-bin
8094

8195
### Nix and NixOS
8296

83-
The Lingua Franca compiler is packaged in [nixpkgs](https://github.com/NixOS/nixpkgs/blob/nixos-23.11/pkgs/development/compilers/lingua-franca/default.nix#L28) and is available via the binary cache.
84-
85-
Run
97+
The Lingua Franca compiler is packaged in [nixpkgs](https://github.com/NixOS/nixpkgs/blob/nixos-23.11/pkgs/development/compilers/lingua-franca/default.nix#L28) and is available via the binary cache. Run
8698
```
8799
nix shell nixpkgs#lingua-franca
88100
```

0 commit comments

Comments
 (0)