diff --git a/README.md b/README.md index bc4fc2c..3eb4af7 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ vscode-flowr is not available on the Visual Studio Marketplace yet. For now, we recommend installing from GitHub Releases, or building from source. ### From GitHub Releases -You can find official releases of the extension in the [Releases](https://github.com/Code-Inspect/vscode-flowr/releases) section of the repository. Simply select the version you'd like to download, open up the Assets section at the bottom, and download the `vscode-flowr-[version].vsix` contained in it. +You can find official releases of the extension in the [Releases](https://github.com/Code-Inspect/vscode-flowr/releases) section of the repository. Simply select the version you would like to download, open up the Assets section at the bottom, and download the `vscode-flowr-[version].vsix` contained in it. From Visual Studio Code, open the Extensions tab and click on the three dots in the top right to select "Install from VSIX..." Alternatively, you can use the Command Palette to select the option directly. Then, you can select the `vsix` file you downloaded to install it. @@ -22,7 +22,9 @@ Then, you can install it the same way as you would the `vsix` downloaded [from G ## Using -We recommend using the [R extension](https://marketplace.visualstudio.com/items?itemName=REditorSupport.r) for Visual Studio Code in addition to this extension. For more information on R development in Visual Studio Code, you can also check out [this helpful article](https://code.visualstudio.com/docs/languages/r). +**To use this extension, a working installation of [R](https://www.r-project.org/) is required**, and R needs to be included in your `PATH` environment variable. You may need to [do so manually](https://www.hanss.info/sebastian/post/rtools-path/) on Windows. (There are [plans](https://github.com/Code-Inspect/vscode-flowr/issues/5) to allow for the extension to install R automatically.) + +Although it is not required, we recommend using the [R extension](https://marketplace.visualstudio.com/items?itemName=REditorSupport.r) for Visual Studio Code along with this extension. For more information on R development in Visual Studio Code, you can also check out [this helpful article](https://code.visualstudio.com/docs/languages/r). ### Slicing You can generate a [slice](https://github.com/Code-Inspect/flowr/wiki/Terminology#program-slice) of the currently highlighted variable in any R code by using the "Slice for Cursor Position" command. All code that is not part of the generated slice will then be grayed out. @@ -39,6 +41,8 @@ After cloning the repository, required dependencies can be installed using [npm] npm ci ``` +Note that this does not install [R](https://www.r-project.org/), which is also not strictly required for development, but obviously highly encouraged. + Opening the cloned repository in Visual Studio Code allows using the [existing launch configurations](https://github.com/Code-Inspect/vscode-flowr/blob/main/.vscode/launch.json) which can launch Visual Studio Code with the extension enabled. To use them, open the Run and Debug view and press the Run button at the top, or use the F5 shortcut to start debugging. You can then open the [example folder](https://github.com/Code-Inspect/vscode-flowr/tree/main/example) contained in this repository to try out the extension for yourself.