From ea3e9c041b486dca58173b2d13a3b99547a5c5f7 Mon Sep 17 00:00:00 2001 From: Martha Bass Date: Wed, 11 Sep 2024 16:07:10 -0500 Subject: [PATCH] Add release notes and system requirements --- _quarto.yml | 5 ++++- docs/release-notes.qmd | 10 ++++++++++ docs/system-requirements.qmd | 23 +++++++++++++++++++++++ 3 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 docs/release-notes.qmd create mode 100644 docs/system-requirements.qmd diff --git a/_quarto.yml b/_quarto.yml index 3b83171..0f69164 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -23,6 +23,8 @@ website: href: docs/get-started.qmd - text: "Install and set up" href: docs/installation.qmd + - text: "Release notes" + href: docs/release-notes.qmd - section: Authentication contents: - text: "Overview" @@ -73,7 +75,8 @@ website: href: docs/geoprocessing/overview.qmd - text: "Making Geoprocessing Tools" href: docs/geoprocessing/creating-gp-tools.qmd - + - text: "System requirements" + href: docs/system-requirements.qmd format: html: diff --git a/docs/release-notes.qmd b/docs/release-notes.qmd new file mode 100644 index 0000000..13df0a2 --- /dev/null +++ b/docs/release-notes.qmd @@ -0,0 +1,10 @@ +--- +title: Releases +--- + + - [`{arcgislayers}`](https://github.com/R-ArcGIS/arcgislayers/blob/main/NEWS.md) + - [`{arcgisutils}`](https://github.com/R-ArcGIS/arcgisutils/blob/main/NEWS.md) + - [`{arcgisgeocode}`](https://github.com/R-ArcGIS/arcgisgeocode/blob/main/NEWS.md) + - [`{arcgisplaces}`](https://github.com/R-ArcGIS/arcgisplaces/blob/main/NEWS.md) + - [`{arcgis}`](https://github.com/R-ArcGIS/arcgis) + - [`{arcgisbinding}`](https://github.com/R-ArcGIS/r-bridge) \ No newline at end of file diff --git a/docs/system-requirements.qmd b/docs/system-requirements.qmd new file mode 100644 index 0000000..9c61d5f --- /dev/null +++ b/docs/system-requirements.qmd @@ -0,0 +1,23 @@ +--- +title: System requirements +--- + +# Operating System +The R-ArcGIS Bridge’s `{arcgis}` meta-package for location services supports Mac OS, Windows, and most Linux distributions. +In order to use the `{arcgisbinding}` package, you must have ArcGIS Pro ≥ 3.1 installed and licensed on a 64-bit Windows machine. + +# R Version +The minimum of version of R supported is 4.1.0. However, we recommend updating your R version whenever possible to keep up with enhancements, features, and any security updates. + +# Dependencies +The `{arcgis}` meta-package consists of many smaller R packages, each of these with different R package dependencies. However, all of them share a dependency on `{arcgisutils}`. + +`{arcgisutils}` is built in part using Rust via [extendr](https://extendr.github.io/). We recommend installing a binary from the [R-universe](https://r-arcgis.r-universe.dev/) or CRAN. +```{r eval = FALSE} +install.packages("arcgis", repos = "https://r-arcgis.r-universe.dev") +``` +If you need to install from source, `rustc` must be available with a minimum version of 1.69. We encourage using the most recent version of `rustc`. + +:::{.callout-tip} +We recommend installing Rust via [`rustup`](https://rustup.rs/). If you are on Windows, you must add the Windows GNU target via `rustup target add x86_64-pc-windows-gnu`. +::: \ No newline at end of file