docs: add notes about pre-built libraries (#195)

A following up for #191
PRQL · Oct 1, 2023 · bea389e · bea389e
1 parent 97fa7ce
commit bea389e
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 5 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,24 @@
 # prqlr (development version)
 
+## New features
+
+- `{prqlr}` can now be installed with "R source package with Rust library binary",
+  inspired by the [`arrow`](https://arrow.apache.org/docs/r/) package,
+  [`string2path`](https://yutannihilation.github.io/string2path/) package,
+  and the [`polars`](https://rpolars.github.io/) package.
+  Available on all currently supported platforms (amd64 and arm64 Linux or macOS, and amd64 Winodws).
+
+  When `NOT_CRAN=ture` or `LIBPRQLR_BUILD=false` is set,
+  the newly added script `tools/prep-lib.R` will search the Internet for the available binary.
+
+  ```r
+  Sys.setenv(NOT_CRAN = "true")
+  install.packages("prqlr")
+  ```
+
+  The URL and sha256 hash of the available binaries are recorded in `tools/lib-sums.tsv`.
+  (#187, #189, #190, #191)
+
 # prqlr 0.5.3
 
 ## New features

diff --git a/README.Rmd b/README.Rmd
@@ -44,8 +44,17 @@ install.packages("prqlr")
 install.packages("prqlr", repos = "https://eitsupi.r-universe.dev")
 ```
 
-For source installation,
-the Rust toolchain (Rust `r RcppTOML::parseTOML("src/rust/Cargo.toml")$package$"rust-version"` or later) must be configured.
+For source installation, pre-built Rust libraries may be available
+if the environment variable `NOT_CRAN` is set to `"true"`. (Or, set `LIBPRQLR_BUILD` to `"false"`)
+
+```r
+Sys.setenv(NOT_CRAN = "true")
+install.packages("prqlr")
+```
+
+Or, the Rust toolchain (Rust `r RcppTOML::parseTOML("src/rust/Cargo.toml")$package$"rust-version"` or later)
+must be configured to build the Rust library.
+
 Please check the <https://github.com/r-rust/hellorust> repository for about Rust code in R packages.
 
 ## Examples

diff --git a/README.md b/README.md
@@ -35,9 +35,20 @@ install.packages("prqlr")
 install.packages("prqlr", repos = "https://eitsupi.r-universe.dev")
 ```
 
-For source installation, the Rust toolchain (Rust 1.65 or later) must be
-configured. Please check the <https://github.com/r-rust/hellorust>
-repository for about Rust code in R packages.
+For source installation, pre-built Rust libraries may be available if
+the environment variable `NOT_CRAN` is set to `"true"`. (Or, set
+`LIBPRQLR_BUILD` to `"false"`)
+
+``` r
+Sys.setenv(NOT_CRAN = "true")
+install.packages("prqlr")
+```
+
+Or, the Rust toolchain (Rust 1.65 or later) must be configured to build
+the Rust library.
+
+Please check the <https://github.com/r-rust/hellorust> repository for
+about Rust code in R packages.
 
 ## Examples