From 2f5e7601eff06ea9f8c8f74682ac976e51ab93b7 Mon Sep 17 00:00:00 2001 From: Ricardo Wurmus Date: Wed, 6 Apr 2022 23:07:44 +0200 Subject: Update README. --- README | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README b/README index a9c9d98..ca285c0 100644 --- a/README +++ b/README @@ -1,14 +1,26 @@ -This R package provides a single procedure =guix.install=, which +This R package provides a single procedure `guix.install`, which allows R users to install R packages via Guix right from within their running R session. If the requested R package does not exist in Guix at this time, the package and all its missing dependencies will be imported recursively and the generated package definitions will be written to -=~/.Rguix/packages.scm=. This record of imported packages can be used +`~/.Rguix/packages.scm`. This record of imported packages can be used later to reproduce the environment, and to add the packages in question to a proper Guix channel (or Guix itself). -=guix.install= not only supports installing packages from CRAN, but +`guix.install` not only supports installing packages from CRAN, but also from Bioconductor or even arbitrary git or mercurial -repositories, replacing the need for installation via devtools. \ No newline at end of file +repositories, replacing the need for installation via devtools. + +# Hacking + +Use [Guix](https://guix.gnu.org) to enter a suitable development +environment and build the package: + +```shell +guix shell +R CMD build . +R CMD check --as-cran guix.install_1.0.0.tar.gz +``` + -- cgit v1.2.3