Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates and cleanups for building the extension #171

Merged
merged 2 commits into from
Jul 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,27 @@ from the VSCode marketplace. See

## Getting started

To check out the repository, build from source, and install the VS Code plugin, run the following command:
To check out the repository, build from source, and install the VS Code plugin, make sure you have the following dependencies:

- `rust`. Rust versions preceding 1.76.0 are not guaranteed to work. See [this web page](https://www.rust-lang.org/tools/install) for instructions on installing Rust.
- `npm`. `npm` versions preceding 10.4.0 are not guaranteed to work.

Then, run the following command:

```
git clone [email protected]:lf-lang/vscode-lingua-franca.git \
git clone --recurse-submodules [email protected]:lf-lang/vscode-lingua-franca.git \
&& cd vscode-lingua-franca \
&& npm install
```

If you do not have a public key set up for authentication with GitHub, you can also use HTTPS:

```
git clone https://github.com/lf-lang/vscode-lingua-franca.git \
git clone --recurse-submodules https://github.com/lf-lang/vscode-lingua-franca.git \
&& cd vscode-lingua-franca \
&& npm install
```

Note that this assumes that you have the WASM dependency somewhere on your system. Eventually, the WASM will probably be published; however, that hasn't been done yet, and it isn't currently possible to build it from source from this open-source repo because it is closed-source.

### Trouble Shooting

#### VS Code is not detected on Mac OS X
Expand Down
2 changes: 1 addition & 1 deletion editor-support
Loading