Skip to content

Commit

Permalink
Merge pull request #24 from R-ArcGIS/add-new-pages
Browse files Browse the repository at this point in the history
Add release notes and system requirements
  • Loading branch information
JosiahParry authored Sep 11, 2024
2 parents 8bcdd08 + ea3e9c0 commit 9681c35
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 1 deletion.
5 changes: 4 additions & 1 deletion _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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:
Expand Down
10 changes: 10 additions & 0 deletions docs/release-notes.qmd
Original file line number Diff line number Diff line change
@@ -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)
23 changes: 23 additions & 0 deletions docs/system-requirements.qmd
Original file line number Diff line number Diff line change
@@ -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`.
:::

0 comments on commit 9681c35

Please sign in to comment.