Skip to content

Commit 4411f3d

Browse files
Refresh documentation after move to the 'futureverse' GitHub organization
1 parent f9c4e9f commit 4411f3d

File tree

4 files changed

+21
-33
lines changed

4 files changed

+21
-33
lines changed

.make/README.md.rsp

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -188,14 +188,8 @@ appveyor <- function(text = FALSE) {
188188

189189
covr <- function() {
190190
bfr <- NULL
191-
files <- c("covr.yaml", "R-CMD-check.yaml")
192-
for (file in file.path(".github/workflows", files)) {
193-
if (file.exists(file)) {
194-
bfr <- readLines(file)
195-
break
196-
}
197-
}
198-
if (!any(grepl("covr::codecov", bfr, fixed=TRUE))) return()
191+
files <- c("test-coverage.yaml", "covr.yaml")
192+
if (!any(file_test("-f", file.path(".github/workflows/", files)))) return()
199193
a("https://app.codecov.io/gh/%s", github_repos(), body=img("https://codecov.io/gh/%s/branch/develop/graph/badge.svg", github_repos(), alt="Coverage Status"))
200194
}
201195
%>

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11

22
# Contributing to the 'future.mirai' package
33

4-
This Git repository uses the [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) branching model (the [`git flow`](https://github.com/petervanderdoes/gitflow-avh) extension is useful for this). The [`develop`](https://github.com/HenrikBengtsson/future.mirai/tree/develop) branch contains the latest contributions and other code that will appear in the next release, and the [`master`](https://github.com/HenrikBengtsson/future.mirai) branch contains the code of the latest release.
4+
This Git repository uses the [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) branching model (the [`git flow`](https://github.com/petervanderdoes/gitflow-avh) extension is useful for this). The [`develop`](https://github.com/futureverse/future.mirai/tree/develop) branch contains the latest contributions and other code that will appear in the next release, and the [`master`](https://github.com/futureverse/future.mirai) branch contains the code of the latest release, which is exactly what is currently on [CRAN](https://cran.r-project.org/package=future.mirai).
55

6-
Contributing to this package is easy. Just send a [pull request](https://help.github.com/articles/using-pull-requests/). When you send your PR, make sure `develop` is the destination branch on the [future.mirai repository](https://github.com/HenrikBengtsson/future.mirai). Your PR should pass `R CMD check --as-cran`, which will also be checked by <a href="https://github.com/HenrikBengtsson/future.mirai/actions?query=workflow%3AR-CMD-check">GitHub Actions</a> and when the PR is submitted.
6+
Contributing to this package is easy. Just send a [pull request](https://help.github.com/articles/using-pull-requests/). When you send your PR, make sure `develop` is the destination branch on the [future.mirai repository](https://github.com/futureverse/future.mirai). Your PR should pass `R CMD check --as-cran`, which will also be checked by <a href="https://github.com/futureverse/future.mirai/actions?query=workflow%3AR-CMD-check">GitHub Actions</a> and when the PR is submitted.
77

88
We abide to the [Code of Conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) of Contributor Covenant.

README.md

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1+
2+
13
<div id="badges"><!-- pkgdown markup -->
2-
<a href="https://CRAN.R-project.org/web/checks/check_results_future.mirai.html"><img b
3-
order="0" src="https://www.r-pkg.org/badges/version/future.mirai" alt="CRAN check status"/></a> <a href="https://github.com/futureverse/future.mirai/actions?query=workflow%3AR-CMD-check"><img border="0" src="https://github.com/futureverse/future.mirai/actions/workflows/R-CMD-check.yaml/badge.svg?branch=develop" alt="R CMD check status"/></a> <a href="https://github.com/futureverse/future.mirai/actions?query=workflow%3Afuture_tests"><img border="0" src="https://github.com/futureverse/future.mirai/actions/workflows/future_tests.yaml/badge.svg?branch=develop" alt="future.tests checks status"/></a> <a href="https://app.codecov.io/gh/futureverse/future.mirai"><img border="0" src="https://codecov.io/gh/futureverse/future.mirai/branch/develop/graph/badge.svg" alt="Coverage Status"/></a>
4+
<a href="https://CRAN.R-project.org/web/checks/check_results_future.mirai.html"><img border="0" src="https://www.r-pkg.org/badges/version/future.mirai" alt="CRAN check status"/></a> <a href="https://github.com/futureverse/future.mirai/actions?query=workflow%3AR-CMD-check"><img border="0" src="https://github.com/futureverse/future.mirai/actions/workflows/R-CMD-check.yaml/badge.svg?branch=develop" alt="R CMD check status"/></a> <a href="https://github.com/futureverse/future.mirai/actions?query=workflow%3Afuture_tests"><img border="0" src="https://github.com/futureverse/future.mirai/actions/workflows/future_tests.yaml/badge.svg?branch=develop" alt="future.tests checks status"/></a> <a href="https://app.codecov.io/gh/futureverse/future.mirai"><img border="0" src="https://codecov.io/gh/futureverse/future.mirai/branch/develop/graph/badge.svg" alt="Coverage Status"/></a>
45
</div>
56

6-
# future.mirai: A Future API for Parallel Processing using 'mirai'
7+
# future.mirai: A 'Future' API for Parallel Processing using 'mirai'
78

89
## Introduction
910

@@ -84,7 +85,7 @@ plan(mirai_multisession)
8485
demo("mandelbrot", package = "future", ask = FALSE)
8586
```
8687

87-
To use `mirai_cluster` futures, use:
88+
and
8889

8990
```r
9091
library(future.mirai)
@@ -95,34 +96,27 @@ demo("mandelbrot", package = "future", ask = FALSE)
9596
```
9697

9798

98-
## Installation
99-
100-
R package **future.mirai** is available on
101-
[CRAN](https://cran.r-project.org/package=future.mirai) and can be
102-
installed in R as:
99+
[mirai]: https://cran.r-project.org/package=mirai
100+
[future]: https://cran.r-project.org/package=future
101+
[future.mirai]: https://github.com/HenrikBengtsson/future.mirai
102+
[future.apply]: https://cran.r-project.org/package=future.apply
103+
[furrr]: https://cran.r-project.org/package=furrr
104+
[doFuture]: https://cran.r-project.org/package=doFuture
103105

106+
## Installation
107+
R package future.mirai is available on [CRAN](https://cran.r-project.org/package=future.mirai) and can be installed in R as:
104108
```r
105109
install.packages("future.mirai")
106110
```
107111

108112

109113
### Pre-release version
110114

111-
To install the pre-release version that is available in Git branch
112-
`develop` on GitHub, use:
113-
115+
To install the pre-release version that is available in Git branch `develop` on GitHub, use:
114116
```r
115117
remotes::install_github("futureverse/future.mirai", ref="develop")
116118
```
117-
118-
This will install the package from source.
119-
120-
121-
[mirai]: https://cran.r-project.org/package=mirai
122-
[future]: https://cran.r-project.org/package=future
123-
[future.mirai]: https://cran.r-project.org/package=future.mirai
124-
[future.apply]: https://cran.r-project.org/package=future.apply
125-
[furrr]: https://cran.r-project.org/package=furrr
126-
[doFuture]: https://cran.r-project.org/package=doFuture
119+
This will install the package from source.
127120

128121
<!-- pkgdown-drop-below -->
122+

pkgdown/_pkgdown.yml.rsp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ home:
2222
- text: The Futureverse Project
2323
href: https://www.futureverse.org/
2424
- text: Futureverse User Forum
25-
href: https://github.com/HenrikBengtsson/future/discussions
25+
href: https://github.com/futureverse/future/discussions
2626

2727
navbar:
2828
structure:

0 commit comments

Comments
 (0)