Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
csouchet committed Nov 3, 2022
1 parent 66ebb74 commit 6654f5b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 11 deletions.
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,15 @@ At this point, you're ready to make your changes! Feel free to ask for help. Eve
devtools::install()
```

### Install the `goodpractice` package
[`goodpractice`](https://github.com/mangothecat/goodpractice) is an R package used to have advice about good practices when building R packages.
It can be installed from the R console:
```r
install.packages('goodpractice')
library('goodpractice')
```
Then, follow the `goodpractice` documentation to execute the package.

### Regenerate the R documentation
The **R documentation** (.Rd) format is generated from the function comments thanks to [roxygen2](https://roxygen2.r-lib.org/). \
To regenerate this documentation after function comment updating, run this command:
Expand Down
14 changes: 3 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,23 +28,15 @@ It is made possible by [htmlwidgets](http://www.htmlwidgets.org/), which provide

## ♻️ Usage
### Installation
#### Install _devtools_
[Devtools](https://www.rdocumentation.org/packages/devtools) is an R package used to ease the installation and the development of other R packages.
#### Install `devtools`
[`devtools`](https://www.rdocumentation.org/packages/devtools) is an R package used to ease the installation and the development of other R packages.
It can be installed from the R console:
```r
install.packages('devtools')
library('devtools')
```

#### Install _goodpractice_
[goodpractice](https://github.com/mangothecat/goodpractice) is an R package used to have advice about good practices when building R packages.
It can be installed from the R console:
```r
install.packages('goodpractice')
library('goodpractice')
```

#### Install _BPMN Visualization - R Package_ from GitHub
#### Install `BPMN Visualization - R Package` from GitHub

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:
```r
Expand Down

0 comments on commit 6654f5b

Please sign in to comment.