From 3564b90c13093ff77d020e920286ae035ff4b631 Mon Sep 17 00:00:00 2001 From: Jakub Nowicki Date: Tue, 3 Sep 2024 11:06:32 +0200 Subject: [PATCH] docs: Imprve How to use section. (#16) --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index beb94ed..cb031dc 100644 --- a/README.md +++ b/README.md @@ -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