Update README.
authorRicardo Wurmus <rekado@elephly.net>
Wed, 6 Apr 2022 21:07:44 +0000 (23:07 +0200)
committerRicardo Wurmus <rekado@elephly.net>
Thu, 7 Apr 2022 07:23:44 +0000 (09:23 +0200)
README

diff --git a/README b/README
index a9c9d98889d96237fbb8f4db279bb6e98552e545..ca285c0e53dbbd8c0a9dda9306c9446f42231e4e 100644 (file)
--- 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
+```
+