Skip to content

Commit e885a99

Browse files
authored
Merge pull request #59 from tbirdso/readme-platforms
DOC: Document supported platforms and architectures
2 parents f2191a0 + f9460e7 commit e885a99

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ or at the [ITK GitHub homepage](https://github.com/insightSoftwareConsortium/ITK
1717
- [`build-test-cxx` Overview](#build-test-cxx-overview)
1818
- [`build-test-package-python` Overview](#build-test-package-python-overview)
1919
- [Contributing](#contributing)
20+
- [Frequently Asked Questions](#frequently-asked-questions)
2021
- [Additional Notes](#additional-notes)
2122
- [Community Discussion](#community-discussion)
2223
- [License](#license)
@@ -325,6 +326,37 @@ Workflow issues may be submitted to the `ITKRemoteModuleBuildTestPackageAction`
325326
[issue tracker](https://github.com/InsightSoftwareConsortium/ITKRemoteModuleBuildTestPackageAction/issues)
326327
on GitHub.
327328

329+
## Frequently Asked Questions
330+
331+
### What target platforms and architectures are supported?
332+
333+
The `build-test-cxx` workflow supports building and running C++ tests on GitHub Actions runner images for
334+
Windows, Linux, and macOS. Image details are available [here](https://github.com/actions/runner-images).
335+
336+
The `build-test-package-python.yml` workflow supports Python package generation for the following platforms and architectures:
337+
- Windows 10 x86_64 platforms
338+
- Windows 11 x86_64 platforms
339+
- macOS 10.9+ x86_64 platforms
340+
- Linux glibc 2.17+ (E.g. Ubuntu 18.04+) x86_64 platforms
341+
- Linux glibc 2.28+ (E.g. Ubuntu 20.04+) aarch64 (ARMv8) platforms
342+
343+
The workflow does not support macOS ARM (Apple Silicon) packages for ITK external modules at this time.
344+
See [GitHub Roadmap issue #528](https://github.com/github/roadmap/issues/528).
345+
346+
### What should I do if my target platform/architecture does not appear on the list above?
347+
348+
Collaborators may build macOS ARM packages manually with
349+
[ITKPythonPackage](https://github.com/insightSoftwareConsortium/ITKPythonPackage) scripts and an Apple Silicon (M1 or M2) machine.
350+
351+
[`itk-wasm`](https://github.com/InsightSoftwareConsortium/itk-wasm) is another experimental path for reproducible execution
352+
across architectures, with planned support for ITK external module Python distributions.
353+
Read more at [https://wasm.itk.org/](https://wasm.itk.org/).
354+
355+
If the answers above do not meet your platform needs, please open an issue in the
356+
[project issue tracker](https://github.com/InsightSoftwareConsortium/ITKRemoteModuleBuildTestPackageAction/issues)
357+
for discussion, and consider contributing either time or funding to support development. The ITK open source ecosystem
358+
is driven through contributions from its community members.
359+
328360
## Additional Notes
329361

330362
`ITKRemoteModuleBuildTestPackageAction` aims to provide boilerplate to simplify CI processes

0 commit comments

Comments
 (0)