From 9e4af8198420dbd2437ca373d6242728aff9f41b Mon Sep 17 00:00:00 2001 From: Bruno Rodrigues Date: Fri, 27 Sep 2024 11:59:07 +0200 Subject: [PATCH] added video intro --- README.Rmd | 15 +++++++++++++++ README.md | 18 ++++++++++++++++++ 2 files changed, 33 insertions(+) diff --git a/README.Rmd b/README.Rmd index 14ddade5..ed938786 100644 --- a/README.Rmd +++ b/README.Rmd @@ -43,6 +43,14 @@ Use cases include running web apps (e.g., Shiny, `{plumber}` APIs) or snapshots package versions, `{rix}` provides an entire ecosystem snapshot, including system-level dependencies. +*Important sidenote: as it so happened, there is currently a bug in the released +CRAN version that we thought we had solved, which we did, but only partially. +When running `rix::rix()` two files should be generated: a `default.nix` and an +`.Rprofile` for your project. It turns out that this file can be empty. If it +is, run `rix::rix_init(rprofile_action = "overwrite")` to generate a proper +`.Rprofile`. This is important, especially on Mac or if you have a system-wide +library of packages! We will submit a fix asap.* + While Nix has a steep learning curve, `{rix}` 1. simplifies creating Nix expressions, which define reproducible environments. @@ -52,6 +60,13 @@ While Nix has a steep learning curve, `{rix}` same code in different development environments, and finally to deploy software environments in production. +If you want to watch a 5-Minute video introduction: + +
+ +
+ + Nix includes nearly all CRAN and Bioconductor packages, with the ability to install specific package versions or GitHub snapshots. Nix also includes Python, Julia (and many of their respective packages) as well as many, many other tools diff --git a/README.md b/README.md index ab3bb31d..1f1d65be 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,15 @@ Use cases include running web apps (e.g., Shiny, `{plumber}` APIs) or which snapshots package versions, `{rix}` provides an entire ecosystem snapshot, including system-level dependencies. +*Important sidenote: as it so happened, there is currently a bug in the +released CRAN version that we thought we had solved, which we did, but +only partially. When running `rix::rix()` two files should be generated: +a `default.nix` and an `.Rprofile` for your project. It turns out that +this file can be empty. If it is, run +`rix::rix_init(rprofile_action = "overwrite")` to generate a proper +`.Rprofile`. This is important, especially on Mac or if you have a +system-wide library of packages! We will submit a fix asap.* + While Nix has a steep learning curve, `{rix}` 1. simplifies creating Nix expressions, which define reproducible @@ -45,6 +54,15 @@ While Nix has a steep learning curve, `{rix}` evaluate the same code in different development environments, and finally to deploy software environments in production. +If you want to watch a 5-Minute video introduction: + +
+ + + +
+ Nix includes nearly all CRAN and Bioconductor packages, with the ability to install specific package versions or GitHub snapshots. Nix also includes Python, Julia (and many of their respective packages) as well