Skip to content
This repository was archived by the owner on Mar 21, 2024. It is now read-only.

Commit cf21d24

Browse files
authored
Merge pull request #1527 from allisonvacanti/README_updates
Update README files.
2 parents 6645382 + 5ef398e commit cf21d24

File tree

2 files changed

+25
-19
lines changed

2 files changed

+25
-19
lines changed

README.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<a href='https://gpuci.gpuopenanalytics.com/job/nvidia/job/thrust/job/branch/job/thrust-cpu-build/CXX_TYPE=gcc,CXX_VER=9,OS_TYPE=ubuntu,OS_VER=20.04,SDK_TYPE=cuda,SDK_VER=11.0-devel/'><img src='https://gpuci.gpuopenanalytics.com/job/nvidia/job/thrust/job/branch/job/thrust-cpu-build/CXX_TYPE=gcc,CXX_VER=9,OS_TYPE=ubuntu,OS_VER=20.04,SDK_TYPE=cuda,SDK_VER=11.0-devel/badge/icon'></a>
22

3-
Thrust: Code at the speed of light
4-
==================================
3+
# Thrust: Code at the speed of light
54

65
Thrust is a C++ parallel programming library which resembles the C++ Standard
76
Library. Thrust's **high-level** interface greatly enhances
@@ -12,15 +11,22 @@ software. Develop **high-performance** applications rapidly with Thrust!
1211

1312
Thrust is included in the NVIDIA HPC SDK and the CUDA Toolkit.
1413

15-
Quick Start: Using Thrust From Your Project
16-
-------------------------------------------
14+
## Quick Start
1715

18-
To use Thrust from your project, first recursively clone the Thrust Github repository:
16+
### Getting the Thrust Source Code
17+
18+
The CUDA Toolkit provides a recent release of the Thrust source code in
19+
`include/thrust`. This will be suitable for most users.
20+
21+
Users that wish to contribute to Thrust or try out newer features should
22+
recursively clone the Thrust Github repository:
1923

2024
```
2125
git clone --recursive https://github.com/NVIDIA/thrust.git
2226
```
2327

28+
### Using Thrust From Your Project
29+
2430
Thrust is a header-only library; there is no need to build or install the project
2531
unless you want to run the Thrust unit tests.
2632

@@ -39,8 +45,7 @@ For non-CMake projects, compile with:
3945
- `-DTHRUST_DEVICE_SYSTEM=THRUST_DEVICE_SYSTEM_XXX`, where `XXX` is
4046
`CPP`, `OMP`, `TBB`, or `CUDA` (default).
4147

42-
Examples
43-
--------
48+
### Examples
4449

4550
Thrust is best explained through examples. The following source code
4651
generates random numbers serially and then transfers them to a parallel
@@ -98,8 +103,16 @@ int main(void)
98103
}
99104
```
100105

101-
CI Status
102-
---------
106+
Additional usage examples can be found in the [`examples/`](examples/) and
107+
[`testing/`](testing/) directories of the Github repo.
108+
109+
## Documentation Resources
110+
111+
- [API Reference](https://thrust.github.io/doc/modules.html)
112+
- [Examples](https://github.com/NVIDIA/thrust/tree/main/examples)
113+
- [User Support](https://github.com/NVIDIA/thrust/discussions)
114+
115+
## CI Status
103116

104117
<a href='https://gpuci.gpuopenanalytics.com/job/nvidia/job/thrust/job/branch/job/thrust-gpu-build/CXX_TYPE=gcc,CXX_VER=7,OS_TYPE=ubuntu,OS_VER=20.04,SDK_TYPE=cuda,SDK_VER=11.3.1-devel/'><img src='https://gpuci.gpuopenanalytics.com/job/nvidia/job/thrust/job/branch/job/thrust-gpu-build/CXX_TYPE=gcc,CXX_VER=7,OS_TYPE=ubuntu,OS_VER=20.04,SDK_TYPE=cuda,SDK_VER=11.3.1-devel/badge/icon?subject=NVCC%2011.3.1%20%2B%20GCC%207%20build%20and%20device%20tests'></a>
105118

@@ -129,8 +142,7 @@ CI Status
129142

130143
<a href='https://gpuci.gpuopenanalytics.com/job/nvidia/job/thrust/job/branch/job/thrust-cpu-build/CXX_TYPE=nvcxx,CXX_VER=21.5,OS_TYPE=ubuntu,OS_VER=20.04,SDK_TYPE=nvhpc,SDK_VER=21.5-devel-cuda11.3/'><img src='https://gpuci.gpuopenanalytics.com/job/nvidia/job/thrust/job/branch/job/thrust-cpu-build/CXX_TYPE=nvcxx,CXX_VER=21.5,OS_TYPE=ubuntu,OS_VER=20.04,SDK_TYPE=nvhpc,SDK_VER=21.5-devel-cuda11.3/badge/icon?subject=NVC%2B%2B%2021.5%20build%20and%20host%20tests'></a>
131144

132-
Supported Compilers
133-
-------------------
145+
## Supported Compilers
134146

135147
Thrust is regularly tested using the specified versions of the following
136148
compilers. Unsupported versions may emit deprecation warnings, which can be
@@ -142,8 +154,7 @@ silenced by defining THRUST_IGNORE_DEPRECATED_COMPILER during compilation.
142154
- Clang 7+
143155
- MSVC 2019+ (19.20/16.0/14.20)
144156

145-
Releases
146-
--------
157+
## Releases
147158

148159
Thrust is distributed with the NVIDIA HPC SDK and the CUDA Toolkit in addition
149160
to GitHub.
@@ -194,8 +205,7 @@ See the [changelog](CHANGELOG.md) for details about specific releases.
194205
| 1.1.0 | |
195206
| 1.0.0 | |
196207

197-
Development Process
198-
-------------------
208+
## Development Process
199209

200210
Thrust uses the [CMake build system](https://cmake.org/) to build unit tests,
201211
examples, and header tests. To build Thrust as a developer, the following

examples/README renamed to examples/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,3 @@ norm example.
55

66
These examples are also available online:
77
https://github.com/NVIDIA/thrust/tree/main/examples
8-
9-
For additional information refer to the Quick Start Guide:
10-
https://github.com/NVIDIA/thrust/wiki/Quick-Start-Guide
11-

0 commit comments

Comments
 (0)