diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index af281bd..e8a51d8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -100,7 +100,20 @@ git push --force-with-lease 25-customize_overlays At this point, you're ready to make your changes! Feel free to ask for help. Everyone is a beginner at first :smile_cat: -## bpmn-visualization-js update +## ⚒️ Development +### Installation +```r +devtools::install() +``` + +### 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: +```r +devtools::document() +``` + +### bpmn-visualization-js update - Change [bpmn-visualization.min.js](inst/htmlwidgets/lib/bpmn-visualization/bpmn-visualization.min.js). The file can be retrieved from [jsdelivr](https://www.jsdelivr.com/package/npm/bpmn-visualization) or [unpkg](https://unpkg.com/browse/bpmn-visualization/). - Update the version of `bpmn-visualization` in [bpmnVisualization.yaml](inst/htmlwidgets/bpmnVisualization.yaml) diff --git a/README.md b/README.md index 2f10d3f..321f4b7 100644 --- a/README.md +++ b/README.md @@ -28,14 +28,14 @@ It is made possible by [htmlwidgets](http://www.htmlwidgets.org/), which provide ## ♻️ Usage ### Installation -Install devtools: -[Devtools](https://www.rdocumentation.org/packages/devtools) is a 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') ``` -Install **BPMN Visualization - R Package** from GitHub: +#### Install _BPMN Visualization - R Package_ from GitHub ```r devtools::install_github("process-analytics/bpmn-visualization-R") library(bpmnVisualization) @@ -124,12 +124,6 @@ You can find more detail in our [Contributing guide](CONTRIBUTING.md). Participa ✨ A BIG thanks to all our contributors 🙂 -## ⚒️ Development -### Installation -```r -devtools::install() -``` - ## 📃 License `bpmn-visualization-R` is released under the [Apache 2.0](LICENSE) license. \