Skip to content

Commit f6ac4fa

Browse files
authored
[DOC] Explain how to install a specific version (#70)
1 parent d315562 commit f6ac4fa

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,9 +133,13 @@ A PR can only be merged into master by a maintainer, if all of these conditions
133133

134134
Maintainers need to perform the following actions **in the order described here** to push out a release.
135135

136-
#### Verify the version in [DESCRIPTION](./DESCRIPTION) file
136+
#### Verify the version in files
137137

138-
Create a new PR and merge it, if the version in the [DESCRIPTION](./DESCRIPTION) file is not good.
138+
Check that the files are using the version to be released:
139+
- [DESCRIPTION](./DESCRIPTION)
140+
- [README](./README.md)
141+
142+
Create a new PR and merge it, if some files require changes.
139143

140144
#### GitHub issues and milestones update
141145

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,19 @@ install.packages('devtools')
3636
```
3737

3838
#### Install _BPMN Visualization - R Package_ from GitHub
39+
40+
To install a dedicated version (available versions can be found in the [GitHub releases page](https://github.com/process-analytics/bpmn-visualization-R/releases)), run:
41+
```r
42+
devtools::install_github("process-analytics/bpmn-visualization-R@v0.1.1")
43+
```
44+
45+
Or install the development version:
3946
```r
4047
devtools::install_github("process-analytics/bpmn-visualization-R")
48+
```
49+
50+
Then, make the library available to the current R project:
51+
```r
4152
library(bpmnVisualization)
4253
```
4354

0 commit comments

Comments
 (0)