Skip to content

Commit 389b835

Browse files
committed
update README
1 parent 3d1ead7 commit 389b835

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
1-
## RcppParallel Package
1+
2+
## RcppParallel
23

34
<!-- badges: start -->
45
[![R-CMD-check](https://github.com/RcppCore/RcppParallel/workflows/R-CMD-check/badge.svg)](https://github.com/RcppCore/RcppParallel/actions)
5-
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/RcppParallel)](https://cran.r-project.org/package=RcppParallel)
6+
[![CRAN](http://www.r-pkg.org/badges/version/RcppParallel)](https://cran.r-project.org/package=RcppParallel)
67
<!-- badges: end -->
78

8-
High level functions for doing parallel programming with Rcpp. For example, the `parallelFor` function can be used to convert the work of a standard serial "for" loop into a parallel one and the `parallelReduce` function can be used for accumulating aggregate or other values.
9+
High level functions for parallel programming with Rcpp. The `parallelFor()` function can be used to convert the work of a standard serial "for" loop into a parallel one, and the `parallelReduce()` function can be used for accumulating aggregate or other values.
910

10-
The high level interface enables safe and robust parallel programming without direct manipulation of operating system threads. On Windows, OS X, and Linux systems the underlying implementation is based on [Intel TBB](https://www.threadingbuildingblocks.org/) (Threading Building Blocks). On other platforms a less-performant fallback implementation based on the [TinyThread](http://tinythreadpp.bitsnbites.eu/) library is used.
11+
The high level interface enables safe and robust parallel programming without direct manipulation of operating system threads. On Windows, OS X, and Linux systems, the underlying implementation is based on [Intel TBB](https://www.threadingbuildingblocks.org/) (Threading Building Blocks). On other platforms, a less-performant fallback implementation based on the [TinyThread](http://tinythreadpp.bitsnbites.eu/) library is used.
1112

1213
For additional documentation on using RcppParallel see the package website at http://rcppcore.github.io/RcppParallel/.
1314

15+
1416
### Intel TBB
1517

16-
`RcppParallel` now supports the new interface of Intel TBB and allows using external library (e.g., with [`oneTBB`](https://github.com/oneapi-src/oneTBB) or the system TBB library), using `TBB_LIB` and `TBB_INC` environment variables.
18+
`RcppParallel` supports the new interface of Intel TBB, and can be configured to use an external copy of TBB (e.g., with [`oneTBB`](https://github.com/oneapi-src/oneTBB) or the system TBB library), using the `TBB_LIB` and `TBB_INC` environment variables.
1719

1820
To build the development version of `RcppParallel` with [`oneTBB`](https://github.com/oneapi-src/oneTBB):
1921

2022
- Install [`oneTBB`](https://github.com/oneapi-src/oneTBB).
2123

2224
For example, installing [`oneTBB`](https://github.com/oneapi-src/oneTBB) on Linux 64-bit (`x86_64`) to `$HOME` directory (change if needed!):
25+
2326
```bash
2427
TBB_VERSION="2021.1.1"
2528

@@ -32,6 +35,7 @@ export TBB="$HOME/oneapi-tbb-$TBB_VERSION"
3235
- Set the TBB environment variables (specifically: `TBB` for the installation prefix, `TBB_INC` for the directory that includes the header files, and `TBB_LIB` for the libraries directory).
3336

3437
For example, installing [`oneTBB`](https://github.com/oneapi-src/oneTBB) on Linux 64-bit (`x86_64`) to `$HOME` directory (change if needed!):
38+
3539
```bash
3640
source $TBB/env/vars.sh intel64
3741

@@ -40,15 +44,17 @@ export TBB_LIB="$TBB/lib/intel64/gcc4.8"
4044
```
4145

4246
- Build the development version of `RcppParallel`:
47+
4348
```r
4449
install.packages("remotes")
45-
remotes::install_github("RcppCore/RcppParallel@develop", force = TRUE)
50+
remotes::install_github("RcppCore/RcppParallel")
4651
```
4752

53+
4854
### License
4955

50-
The RcppParallel package is made available under the [GPLv2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html).
56+
The RcppParallel package is made available under the [GPLv2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html) license.
5157

52-
The TinyThread library is licensed under the [zlib/libpng](http://www.opensource.org/licenses/zlib-license.php) license as described [here](https://gitorious.org/tinythread/tinythreadpp/source/master:README.txt).
58+
The [TinyThread library](https://tinythreadpp.bitsnbites.eu/) is licensed under the [zlib/libpng](http://www.opensource.org/licenses/zlib-license.php) license.
5359

54-
The Intel TBB Library is licensed under the Apache 2.0 (as described at https://www.threadingbuildingblocks.org/faq/10).
60+
The Intel TBB Library is licensed under the Apache 2.0 license, as described at https://github.com/oneapi-src/oneTBB/blob/master/LICENSE.txt.

0 commit comments

Comments
 (0)