Skip to content

Commit 1ace27d

Browse files
authored
Update repo Readme.md (#1308)
Update readme to reflect the current changes in repo behavior, which is that the master branch is stable and works with current released toolkits.
1 parent 32a886d commit 1ace27d

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

README.md

+20-8
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,38 @@
22

33
The oneAPI-samples repository contains samples for the [Intel® oneAPI Toolkits](https://www.intel.com/content/www/us/en/developer/tools/oneapi/toolkits.html).
44

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

77
## Get the oneAPI Samples
88

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

11-
Clone a stable version of the repository using Git by entering a command similar to the following:
11+
`git clone https://github.com/oneapi-src/oneAPI-samples.git`
12+
13+
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:
1224

1325
`git clone -b <tag> https://github.com/oneapi-src/oneAPI-samples.git`
1426

15-
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**.
1628

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

1931
1. Select the appropriate tag.
2032
2. Click the **Code** button.
2133
3. Select **Download ZIP** from the menu options.
2234
4. After downloading the file, unzip the repository contents.
2335

24-
### Getting Started with oneAPI Samples
36+
## Getting Started with oneAPI Samples
2537

2638
The best oneAPI sample to start with depends on what you are trying to learn or types of problems you are trying to solve.
2739

@@ -32,7 +44,7 @@ The best oneAPI sample to start with depends on what you are trying to learn or
3244
| 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)
3345
| 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
3446

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.
3648
3749
### Using Integrated Development Environments (IDE)
3850

@@ -73,4 +85,4 @@ Third-party program licenses can be found here: [third-party-programs.txt](https
7385

7486
## Notices and Disclaimers
7587

76-
© Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others.
88+
© Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others.

0 commit comments

Comments
 (0)