Skip to content

Commit 577742b

Browse files
authored
add license information, update README (#39)
1 parent d15180a commit 577742b

File tree

1 file changed

+28
-12
lines changed

1 file changed

+28
-12
lines changed

README.rst

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,32 @@
22
..
33
.. SPDX-License-Identifier: CC-BY-4.0
44
5-
============================
6-
Intel\ |r| oneAPI CI Samples
7-
============================
5+
=================================
6+
Intel\ :sup:`®` oneAPI CI Samples
7+
=================================
88

99
.. image:: https://api.reuse.software/badge/github.com/oneapi-src/oneapi-ci
1010
:target: https://api.reuse.software/info/github.com/oneapi-src/oneapi-ci
1111
:alt: REUSE status
1212

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:
1618

1719
=============== ===========================================
1820
Compilers icc, ifort, dpcpp
1921
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
2123
=============== ===========================================
2224

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.
2530

26-
For a complete list of components available for installation,
27-
see |ListComponentsStatus|.
2831

2932
Status
3033
======
@@ -56,6 +59,13 @@ Azure |c| |c| |c| |c| |c| |c|
5659
======== ========= ========= ============ ===== ======= ===========
5760

5861

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+
5969
Troubleshooting
6070
===============
6171

@@ -65,7 +75,10 @@ Those logs can be helpful in case of installation issues.
6575
License
6676
=======
6777

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`_.
6982

7083
Contribute
7184
==========
@@ -77,6 +90,9 @@ Security
7790

7891
See `security guidelines`_.
7992

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
8096
.. _licenses: LICENSES
8197
.. _contributing: CONTRIBUTING.rst
8298
.. _`security guidelines`: https://www.intel.com/content/www/us/en/security-center/default.html

0 commit comments

Comments
 (0)