Skip to content

Commit 7e59ea5

Browse files
authored
Merge pull request #88 from zivy/improveDocumentation
Improve documentation.
2 parents 060046a + 33b8a79 commit 7e59ea5

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66

77
A [remotes](https://github.com/r-lib/remotes) based installer for SimpleITK in [R](https://www.r-project.org/).
88

9-
Default configuration, single core compilation:
9+
Default configuration, minimal compute resources but takes a long time, single core compilation:
1010

1111
```R
1212
remotes::install_github("SimpleITK/SimpleITKRInstaller")
1313
```
1414

15-
Turn on mutlicore compilation, six cores in this example
15+
Turn on mutlicore compilation, **recommended configuration**, six cores in this example:
1616

1717
```R
1818
Sys.setenv(MAKEJ=6)
@@ -30,7 +30,7 @@ remotes::install_github("SimpleITK/SimpleITKRInstaller")
3030
Note:
3131
On Linux and Mac requires [CMake](https://cmake.org/) and [git](https://git-scm.com/) in the path.
3232

33-
On Windows requires [rtools](https://cran.r-project.org/bin/windows/Rtools/) installation and setting the `RTOOLS_HOME` environment variable. For example:
33+
On Windows requires [rtools](https://cran.r-project.org/bin/windows/Rtools/) installation and setting the `RTOOLS_HOME` environment variable. Install the rtools version that matches the targeted R version. For example, using the R4.5.3 and rtools4.5 combination, set the enviornment variable to:
3434
```R
3535
Sys.setenv(RTOOLS_HOME = "C:/rtools45")
3636
```

0 commit comments

Comments
 (0)