Skip to content

Commit f692d6e

Browse files
committed
Update foyer information.
Update the foyer information and exclude it from the build process.
1 parent 28cc1bb commit f692d6e

3 files changed

Lines changed: 9 additions & 5 deletions

File tree

.github/workflows/main.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,13 @@ on:
44
- main
55
tags:
66
- 'v*' # Trigger on version tags
7+
paths-ignore:
8+
- 'SimpleITK_Foyer/**'
79
pull_request:
810
branches:
911
- main
12+
paths-ignore:
13+
- 'SimpleITK_Foyer/**'
1014
workflow_dispatch:
1115
# enable manual triggering
1216
schedule:

SimpleITK_Foyer/DESCRIPTION

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Authors@R: c(person("Richard", "Beare", role = "aut",
77
email = "blowekamp@mail.nih.gov"),
88
person("Ziv", "Yaniv", role = c("aut", "cre"),
99
email = "zivyaniv@nih.gov"))
10-
Description: Provides a lightweight installer for the SimpleITK package, which
10+
Description: A lightweight installer for the SimpleITK image analysis package, which
1111
is an interface to the Insight Toolkit (ITK) for medical image segmentation
12-
and registration. After installing this package, call install_simpleitk().
12+
and registration. After installing this package, call install_simpleitk()
1313
to download and install the pre-built binary packages for your platform
1414
from the SimpleITKRInstaller GitHub releases. Due to the large size of the compiled
1515
package, the actual functionality is distributed as platform-specific binaries

SimpleITK_Foyer/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ This is a lightweight installer package for SimpleITK, providing easy access to
44

55
## Installation
66

7-
Install the SimpleITK foyer package from GitHub Pages:
7+
Install the SimpleITK foyer package from r-universe:
88
```r
99
install.packages("SimpleITK.foyer",
10-
repos = "https://SimpleITK.github.io/SimpleITKRInstaller",
10+
repos = "https://simpleitk.r-universe.dev",
1111
type = "source")
1212
```
1313

@@ -37,7 +37,7 @@ img <- ReadImage("path/to/image.dcm")
3737

3838
The full SimpleITK package is quite large (~40-50 MB depending on platform) and requires significant compilation time when built from source. To make it easier for users, we distribute:
3939

40-
1. **This lightweight foyer package** - hosted on GitHub Pages as a CRAN-like repository
40+
1. **This lightweight foyer package** - hosted on the r-universe CRAN-like platform
4141
2. **Pre-built binaries on GitHub Releases** - the actual SimpleITK package
4242

4343
The foyer package installs instantly and provides the `install_simpleitk()` function which downloads the correct pre-built binary for your platform.

0 commit comments

Comments
 (0)