2
2
..
3
3
.. SPDX-License-Identifier: CC-BY-4.0
4
4
5
- ============================
6
- Intel\ | r | oneAPI CI Samples
7
- ============================
5
+ =================================
6
+ Intel\ :sup: `®` oneAPI CI Samples
7
+ =================================
8
8
9
9
.. image :: https://api.reuse.software/badge/github.com/oneapi-src/oneapi-ci
10
10
:target: https://api.reuse.software/info/github.com/oneapi-src/oneapi-ci
11
11
:alt: REUSE status
12
12
13
- This repo contains sample Public/Cloud CI configurations that
14
- demonstrate installing Intel\ |r | oneAPI toolkit components and building
15
- applications:
13
+ This repository contains sample Public/Cloud CI configurations that
14
+ demonstrate installing Intel\ :sup: `®` oneAPI toolkit components and
15
+ building applications. You may also find this repository useful for
16
+ automating the install process on your own systems. The following
17
+ configurations are supported:
16
18
17
19
=============== ===========================================
18
20
Compilers icc, ifort, dpcpp
19
21
OS platforms Linux, Windows, MacOS
20
- Install methods Intel\ | r | installer, apt, dnf, docker container, CI cache
22
+ Install methods Intel installer, apt, dnf, docker container, CI cache
21
23
=============== ===========================================
22
24
23
- The config files show examples of all supported configurations. Delete
24
- the ones you do not want.
25
+ The config files are intended to be samples that demonstrate a wide
26
+ variety of use cases. For you own use, select the parts that you
27
+ need. You may also want to customize the set of compilers and
28
+ libraries that are installed. See `component listings `_ for the
29
+ component names to use in the scripts.
25
30
26
- For a complete list of components available for installation,
27
- see |ListComponentsStatus |.
28
31
29
32
Status
30
33
======
@@ -56,6 +59,13 @@ Azure |c| |c| |c| |c| |c| |c|
56
59
======== ========= ========= ============ ===== ======= ===========
57
60
58
61
62
+ Caching
63
+ =======
64
+
65
+ Some of the oneAPI components are large and can take a few minutes to
66
+ download install. To accelerate install, we demonstrate the use of
67
+ caching.
68
+
59
69
Troubleshooting
60
70
===============
61
71
@@ -65,7 +75,10 @@ Those logs can be helpful in case of installation issues.
65
75
License
66
76
=======
67
77
68
- See licenses _
78
+ The contents of this repository follows the SPDX _ standard for
79
+ documenting license information. The Intel oneAPI compilers and
80
+ libraries are distributed separately. They are free to use and are
81
+ governed by the `oneAPI EULA `_.
69
82
70
83
Contribute
71
84
==========
@@ -77,6 +90,9 @@ Security
77
90
78
91
See `security guidelines `_.
79
92
93
+ .. _`component listings` : https://oneapi-src.github.io/oneapi-ci/
94
+ .. _SPDX : https://spdx.dev/
95
+ .. _`oneAPI EULA` : https://software.intel.com/content/www/us/en/develop/articles/end-user-license-agreement.html
80
96
.. _licenses : LICENSES
81
97
.. _contributing : CONTRIBUTING.rst
82
98
.. _`security guidelines` : https://www.intel.com/content/www/us/en/security-center/default.html
0 commit comments