From 1a7fd361192ed57da926029dbff465f63145d127 Mon Sep 17 00:00:00 2001 From: Peter Donovan Date: Wed, 24 Jul 2024 12:36:05 -0700 Subject: [PATCH 1/2] Silence compilation warnings --- editor-support | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/editor-support b/editor-support index 40ab2c38f..f1c196a27 160000 --- a/editor-support +++ b/editor-support @@ -1 +1 @@ -Subproject commit 40ab2c38f9b6f4dc2650889c522c80f51a66fc84 +Subproject commit f1c196a2765dda3787ca2cd30e07cd4fc032e614 From d2ac9905c095d991b223acdb6499bb24564044ba Mon Sep 17 00:00:00 2001 From: Peter Donovan Date: Wed, 24 Jul 2024 13:41:31 -0700 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 49e2e394b..f7bd21b41 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,10 +11,15 @@ 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 git@github.com:lf-lang/vscode-lingua-franca.git \ +git clone --recurse-submodules git@github.com:lf-lang/vscode-lingua-franca.git \ && cd vscode-lingua-franca \ && npm install ``` @@ -22,13 +27,11 @@ git clone git@github.com:lf-lang/vscode-lingua-franca.git \ 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