Skip to content

Commit 7ff70e5

Browse files
authored
Fix typos and minor changes in README
1 parent 4d2e942 commit 7ff70e5

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
R/Java interface allowing the use of Java from R as well as embedding
88
R into Java (via JRI)
99

10-
Please visit the [main rJava project page on RForge.net](https://rforge.net/rJava) for details.
10+
Please visit the [main rJava project page on RForge.net](https://rforge.net/rJava) for details on the project. For some FAQs and troubleshooting see below - read before reporting bugs!
1111

1212
### Installation
1313

@@ -19,7 +19,7 @@ in R. If you have all tools (and knowledge) necessary to compile
1919
R packages from sources, you can install the latest development
2020
version with
2121

22-
install.packages("rJava", repos="http://rforge.net")
22+
install.packages("rJava", repos="https://rforge.net")
2323

2424
The RForge.net repository is updated automatically on each
2525
commit. On macOS/Windows you may need to add `type='source'`.
@@ -40,21 +40,21 @@ generate one (which involves compilation of Java code).
4040
### Bug reports
4141

4242
Please use [rJava GitHub issues page](https://github.com/s-u/rJava/issues) to
43-
report bugs.
43+
report bugs, but read the following documentation and search previous issues before you do so.
4444

4545
## Troubleshooting
4646

4747
Rule #1: do __not__ set `JAVA_HOME` unless you are an expert. rJava attempts to find the correct settings automatically on most platforms, so setting `JAVA_HOME` incorrecty will just break things.
4848

4949
### Windows
5050

51-
Please make sure you install Java that matches your R architecture. R from CRAN is installed by default both in 32-bit and 64-bit versions so if in doubt, install both 32-bit and 64-bit Java. Teh most common mistake is to use 64-bit R but only have 32-bit Java installed.
51+
Please make sure you install Java that matches your R architecture. R from CRAN is installed by default both in 32-bit and 64-bit versions so if in doubt, install both 32-bit and 64-bit Java. The most common mistake is to use 64-bit R but only have 32-bit Java installed.
5252

5353
rJava determines the Java location from the registry, so make sure you use the official Oracle installer so that your Java installation can be found.
5454

5555
### macOS
5656

57-
On modern macOS versions Apple no longer supplies Java, so it must be downloaded from 3rd parties. Probably the most commonly used distribution on macOS are [adoptium.net](https://adoptium.net) and [Azul Zulu](https://www.azul.com/downloads/). Please note that if you are using arm64 R on Apple silicon (M1+) based Macs you will need latest R-4.1.1-patched from https://mac.R-project.org or else you will get `trap R` errors when loading Java (see [#267](https://github.com/s-u/rJava/issues/267) for details).
57+
On modern macOS versions Apple no longer supplies Java, so it must be downloaded from 3rd parties. Probably the most commonly used distributions on macOS are [adoptium.net](https://adoptium.net) and [Azul Zulu](https://www.azul.com/downloads/). Please note that if you are using arm64 R on Apple silicon (M1+) based Macs you will need at least R-4.1.2 or else you will get `trap R` errors when loading Java (see [#267](https://github.com/s-u/rJava/issues/267) for details).
5858

5959
When installing from a zip or tar ball, put your Java installation in `/Library/Java/JavaVirtualMachines`. For example, if installing Zulu, unpack/move it such that it results in `/Library/Java/JavaVirtualMachines/zulu-11.jdk`.
6060

@@ -70,11 +70,11 @@ Also note that `sudo` may change environment variables, so if you need to run wi
7070

7171
The way Java R configuration on Linux works is for the `R` start script to modify `LD_LIBRARY_PATH` to make sure the JVM libraries can be loaded (it does so according to the `javaconf` settings). Therefore if you use a process embbedding R you need to run it via `R CMD <program>` such that those setting are honored, otherwise you're on your own.
7272

73-
If you are installing rJava from sources, make sure you have a full JDK installed and all the necessary libraries needed to compile packages. For example, on Debian/Ubuntu that would require at least `r-base-dev`. If you run into issues, please check `config.log` which gives a clue as to what went wrong - usually some missing R dependency such as `pcre2`. The `config.log` file will be in the directory you used to build rJava in which is claned by R by default, so to keep it you can use e.g.:
73+
If you are installing rJava from sources, make sure you have the full JDK installed and all the necessary libraries needed to compile packages. For example, on Debian/Ubuntu that would require at least `r-base-dev`. If you run into issues, please check `config.log` which gives a clue as to what went wrong - usually some missing R dependency such as `pcre2`. The `config.log` file will be in the directory you used to build rJava in which is claned by R by default, so to keep it you can use e.g.:
7474

7575
```
76-
curl -LO https://rforge.net/rJava/snapshot/rJava_1.0-4.tar.gz
77-
tar fxz rJava_1.0-4.tar.gz
76+
curl -LO https://rforge.net/rJava/snapshot/rJava_1.0-6.tar.gz
77+
tar fxz rJava_1.0-6.tar.gz
7878
R CMD INSTALL rJava
7979
## on failure check rJava/config.log
8080
```

0 commit comments

Comments
 (0)