You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-8
Original file line number
Diff line number
Diff line change
@@ -2,26 +2,38 @@
2
2
3
3
The oneAPI-samples repository contains samples for the [Intel® oneAPI Toolkits](https://www.intel.com/content/www/us/en/developer/tools/oneapi/toolkits.html).
4
4
5
-
**The latest versions of code samples on the master branch are not guaranteed to be stable.** Use a [stable release version](https://github.com/oneapi-src/oneAPI-samples/tags) of the repository.
5
+
The contents of the default branch in this repository are meant to be used with the most recent released version of the Intel® oneAPI Toolkits.
6
6
7
7
## Get the oneAPI Samples
8
8
9
-
The version of the repository you use should match the version of the Intel® oneAPI Toolkit you have installed, particularly for the compilers.
9
+
Clone the repository by entering the following command:
10
10
11
-
Clone a stable version of the repository using Git by entering a command similar to the following:
Alternatively, you can download a zip file containing the primary branch in repository.
14
+
15
+
1. Click the **Code** button.
16
+
2. Select **Download ZIP** from the menu options.
17
+
3. After downloading the file, unzip the repository contents.
18
+
19
+
### Get Earlier Versions of the oneAPI Samples
20
+
21
+
If you need samples for an earlier version of any of the Intel® oneAPI Toolkits, then use a [tagged version](https://github.com/oneapi-src/oneAPI-samples/tags) of the repository that corresponds with the toolkit version.
22
+
23
+
Clone an earlier version of the repository using Git by entering a command similar to the following:
where `<tag>` is the stable version number, like **2023.0.0**.
27
+
where `<tag>` is the GitHub tag corresponding to the toolkit version number, like **2023.0.0**.
16
28
17
-
Alternatively, you can download a zip file containing a stable version of the repository.
29
+
Alternatively, you can download a zip file containing a specific tagged version of the repository.
18
30
19
31
1. Select the appropriate tag.
20
32
2. Click the **Code** button.
21
33
3. Select **Download ZIP** from the menu options.
22
34
4. After downloading the file, unzip the repository contents.
23
35
24
-
###Getting Started with oneAPI Samples
36
+
## Getting Started with oneAPI Samples
25
37
26
38
The best oneAPI sample to start with depends on what you are trying to learn or types of problems you are trying to solve.
27
39
@@ -32,7 +44,7 @@ The best oneAPI sample to start with depends on what you are trying to learn or
32
44
| the basics of image rendering workloads and ray tracing | [Getting Started Samples for Intel® oneAPI Rendering Toolkit (Render Kit)](https://github.com/oneapi-src/oneAPI-samples/tree/master/RenderingToolkit/GettingStarted)
33
45
| how to modify or create build files for SYCL-compliant projects | [Vector Add](https://github.com/oneapi-src/oneAPI-samples/tree/master/DirectProgramming/C++SYCL/DenseLinearAlgebra/vector-add) sample
34
46
35
-
>**Note**: The README.md included with each samples provides build instructions for all supported operating system. For samples run in Jupyter Notebooks, you might need to install or configure additional frameworks or package managers if you do not already have them on your system.
47
+
>**Note**: The README.md included with each sample provides build instructions for all supported operating system. For samples run in Jupyter Notebooks, you might need to install or configure additional frameworks or package managers if you do not already have them on your system.
36
48
37
49
### Using Integrated Development Environments (IDE)
38
50
@@ -73,4 +85,4 @@ Third-party program licenses can be found here: [third-party-programs.txt](https
0 commit comments