Skip to content

Commit 0217666

Browse files
committed
re-render readme
1 parent ce8868e commit 0217666

1 file changed

Lines changed: 16 additions & 6 deletions

File tree

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,17 @@ working directory (via `.Rprofile`, with the user’s consent). Similar to
4747
what `{renv}` does for `R` packages, `{rJavaEnv}` allows different
4848
`Java` versions to be used across different projects, but can also be
4949
configured to allow multiple versions within the same project (e.g. with
50-
the help of `{targets}` package). **Note: there are a few extra steps
51-
for ‘Linux’ users, who don’t have any ‘Java’ previously installed in
52-
their system, and who prefer package installation from source, rather
53-
then installing binaries from ‘Posit Package Manager’. See
50+
the help of `{targets}` package). For users who need to install
51+
`{rJava}` or other `Java`-dependent packages from source, `{rJavaEnv}`
52+
will display a message with instructions on how to run
53+
`R CMD javareconf` to make the Java configuration permanent, but also
54+
provides a function `java_build_env_set()` that sets the environment
55+
variables in the current R session temporarily to allow installation of
56+
`{rJava}` from source without `R CMD javareconf`. On Linux, in addition
57+
to setting environment variables, `{rJavaEnv}` also dynamically loads
58+
`libjvm.so` to ensure `{rJava}` works correctly. See
5459
[documentation](https://www.ekotov.pro/rJavaEnv/articles/rJavaEnv.html#note-linux)
55-
for details.**
60+
for more details.\*\*
5661

5762
## Install
5863

@@ -132,7 +137,7 @@ rje_consent(provided = TRUE)
132137

133138
## Using `rJavaEnv` with `targets` and `callr`
134139

135-
Just insert this line into the begining of any script that you run with
140+
Just insert this line at the top of any script that you run with
136141
`targets` or `callr`:
137142

138143
``` r
@@ -216,6 +221,11 @@ architecture.
216221
project directory and does not create or edit your `.Rprofile` file.
217222
Only sets requested java in the current R session.
218223

224+
12. `java_build_env_set()` (and `java_build_env_unset()`)
225+
226+
- Similar to `java_env_set()`, but specifically designed for setting
227+
`Java` environment variables for building `rJava` from source.
228+
219229
See more details on all the functions in the
220230
<a href="https://www.ekotov.pro/rJavaEnv/reference/index.html"
221231
target="_blank">Reference</a>.

0 commit comments

Comments
 (0)