From 6654f5bb0ac14433ef23841825ade16065365cb6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Souchet=20C=C3=A9line?= Date: Fri, 28 Oct 2022 09:39:29 +0200 Subject: [PATCH] Update doc --- CONTRIBUTING.md | 9 +++++++++ README.md | 14 +++----------- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2de7168..5e23406 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: diff --git a/README.md b/README.md index c77ebd7..92c3628 100644 --- a/README.md +++ b/README.md @@ -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