Skip to content

Improve documentation. #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zivy merged 1 commit into from
Apr 14, 2026
Merged

Improve documentation. #88

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@

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

Default configuration, single core compilation:
Default configuration, minimal compute resources but takes a long time, single core compilation:

```R
remotes::install_github("SimpleITK/SimpleITKRInstaller")
```

Turn on mutlicore compilation, six cores in this example
Turn on mutlicore compilation, **recommended configuration**, six cores in this example:

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

On Windows requires [rtools](https://cran.r-project.org/bin/windows/Rtools/) installation and setting the `RTOOLS_HOME` environment variable. For example:
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:
```R
Sys.setenv(RTOOLS_HOME = "C:/rtools45")
Copy link
Copy Markdown
Member

@blowekamp blowekamp Apr 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure this is correct or necessary. When the R package is built certain env variable are set, we are using these a little but and could do better to use them in the scripts.

Copy link
Copy Markdown
Member Author

@zivy zivy Apr 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Setting the RTOOLS_HOME is required as it changes per the rtools version (enabling multiple rtools version on same machine). The matching with the R major.minor version is required per the rtools documentation.

```
Expand Down
Loading