Skip to content

Commit

Permalink
docs: Imprve How to use section. (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
jakubnowicki authored Sep 3, 2024
1 parent 2a3ca0d commit 3564b90
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,15 @@ The code is based on initial work by [Pavel Demin](https://github.com/Gotfrid).

## How to use

1. `box.lsp::use_box_lsp()` to configure your project's `.Rprofile` file.
2. Restart the R session to load `.Rprofile`.
1. Install `box.lsp` and `langaugeserver` (`languageserver` is not going to be installed by default!).

> __NOTE__: In Rhino, install `box.lsp` with `rhino::pkg_install("box.lsp")` and `languageserver` with `renv::install("languageserver")`.
`box.lsp` needs to be added to `dependencies.R` and stored in `renv.lock`, as it will be used in `.Rprofile`.
On the other hand, installing `languageserver` makes sense only if one uses VSCode or Vim, and should be used on the level of the
developer's environment.

2. `box.lsp::use_box_lsp()` to configure your project's `.Rprofile` file.
3. Restart the R session to load `.Rprofile`.

## How to develop

Expand Down

0 comments on commit 3564b90

Please sign in to comment.