diff --git a/README.Rmd b/README.Rmd index c00efe0..bce77f9 100644 --- a/README.Rmd +++ b/README.Rmd @@ -147,3 +147,7 @@ browseURL(pdf_sum_path) The report provides additional context, session info, proof points, etc., but will render a table that looks like the one below: + +## Rendering scorecards for non-R packages + +The workflow described above focuses on **R** packages. Generating scorecards for other types of packages is also supported. In this case, the scoring happens outside of `mpn.scorecard`, and a directory of results is fed to `render_scorecard`. The required input format is described at [`?external_scores`](https://metrumresearchgroup.github.io/mpn.scorecard/reference/external_scores.html). diff --git a/README.md b/README.md index 498dc32..78a9e07 100644 --- a/README.md +++ b/README.md @@ -172,3 +172,12 @@ The report provides additional context, session info, proof points, etc., but will render a table that looks like the one below: + +## Rendering scorecards for non-R packages + +The workflow described above focuses on **R** packages. Generating +scorecards for other types of packages is also supported. In this case, +the scoring happens outside of `mpn.scorecard`, and a directory of +results is fed to `render_scorecard`. The required input format is +described at +[`?external_scores`](https://metrumresearchgroup.github.io/mpn.scorecard/reference/external_scores.html).