Skip to content

Commit 7611655

Browse files
Update readme
1 parent 43faa16 commit 7611655

File tree

2 files changed

+8
-18
lines changed

2 files changed

+8
-18
lines changed

configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ Breakpoints and the modified `print`/`cat`/`message` functions are applied in th
7474
that also prints a link to the file and line number in the debug console.
7575
This overwrite does not affect print statements in packages.
7676
* `"overwriteCat"`: Same as above for `cat()`
77+
* `"overwriteMessage"`: Same as above for `message()`
7778
* `"overwriteSource"`: Whether to overwrite the `source` function with a custom version
7879
that is affected by breakpoints set in VS Code.
7980

readme.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,15 @@ For many variables it is also possible to assign a new value to the variable or
2424

2525

2626
## Installation
27-
The latest "stable" version of the VS Code extension and the R package can be found on the
28-
[Releases Site](https://github.com/ManuelHentschel/VSCode-R-Debugger/releases).
29-
For compatibility reasons make sure to install both from the same release.
30-
31-
32-
You can also try to install the R package automatically by entering the command
33-
`rdebugger.updateRPackage`
34-
in the command bar (ctrl+shift+p).
35-
This function will simply try to load and install the correct binary from the github repo linked above.
27+
The latest "stable" version of the VS Code extension can be installed from the
28+
[marketplace](https://marketplace.visualstudio.com/items?itemName=RDebugger.r-debugger).
29+
After installing the extension, the R package can be installed using the command
30+
`rdebugger.updateRPackage`.
31+
If this does not work, you can find the source code and compiled binaries on the
32+
[releases site](https://github.com/ManuelHentschel/VSCode-R-Debugger/releases).
3633

3734
The provided binaries were compiled using R 4.0.2 and might be incompatible with older R versions.
38-
In these cases it is necessary to compile the package from code (see below).
35+
In these cases it is necessary to compile the package from code.
3936

4037
If you want to install a development version, the VS Code extension can be installed from the .vsix-files found
4138
[here](https://github.com/ManuelHentschel/VSCode-R-Debugger/actions?query=workflow%3Amain).
@@ -46,11 +43,6 @@ To install the latest development version of the required R-package from GitHub,
4643
or install from the artifacts found
4744
[here](https://github.com/ManuelHentschel/vscDebugger/actions).
4845

49-
Installing/running from code is a little more involved, but the files `.vscode/tasks.json` and `tsconfig.json` from this repo
50-
as well as `build.R` and `.vscode/tasks.json` from [vscDebugger](https://github.com/ManuelHentschel/vscDebugger)
51-
might be helpful.
52-
53-
5446
## Using the Debugger
5547
* Install this extension in VS Code.
5648
* Install the package [**vscDebugger**](https://github.com/ManuelHentschel/vscDebugger) in R.
@@ -62,9 +54,6 @@ expressions entered into the debug console are evaluated in the currently active
6254
* During debugging in the global workspace it is often necessary to click the dummy frame
6355
in the callstack labelled 'Global Workspace' to see the variables in `.GlobalEnv`.
6456

65-
<!-- *For Windows users: If your R installation is from [CRAN](http://cran.r-project.org/mirrors.html) with default installation settings, especially **Save version number in registry** is enabled, then there's no need to specify `rdebugger.rterm.windows`.* -->
66-
67-
6857
## Launch config
6958
The behaviour of the debugger can be configured with the entry `"debugMode"`,
7059
which can be one of the values `"function"`, `"file"`, and `"workspace"`.

0 commit comments

Comments
 (0)