diff --git a/README.md b/README.md index 235bbe5..ca77f95 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ CRAN Debian server. Therefore we do not need to worry about system requirements: if the package can be built on CRAN, it can also build in the rcheckserver containers. -## How to use in local R +## How to run locally This will check your package and reverse dependencies from CRAN in your local R: @@ -53,9 +53,18 @@ This will check your package and reverse dependencies from CRAN in your local R: recheck::recheck("mypackage_1.0.tar.gz") ``` -To run this on GitHub actions use: +Alternatively to run it in the Ubuntu container, you need to mount a local source package in the container and then pass the path as an argument. For example: +```sh +# Download some example file: +# curl -OL "https://ropensci.r-universe.dev/src/contrib/qpdf_1.3.3.tar.gz" +docker run -it -v "qpdf_1.3.3.tar.gz:/qpdf_1.3.3.tar.gz" ghcr.io/r-universe-org/recheck "/qpdf_1.3.3.tar.gz" ``` +Or you can pass a URL to a public source package: + +```sh +docker run -it ghcr.io/r-universe-org/recheck "https://ropensci.r-universe.dev/src/contrib/qpdf_1.3.3.tar.gz" ``` +## How to run on GitHub Actions