-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1a7fd36
commit d2ac990
Showing
1 changed file
with
8 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|