Skip to content

Commit

Permalink
minor tweak to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Ian Jonsen committed Feb 18, 2023
1 parent 74931d0 commit 0fb1e17
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ options(repos = c(ianjonsen = 'https://ianjonsen.r-universe.dev',
```

### READ THIS CAREFULLY if you are unsure about compiler tools:
If you don't have compiler tools installed, are uncertain if you do, or have trouble getting them to work then you can manually download a binary version of the `{aniMotum}` package for Windows or Intel Mac from here https://ianjonsen.r-universe.dev/ui#package:aniMotum. There are 3 binary versions for Windows & Mac, each corresponds to a different major release of R: 4.3, 4.2, and 4.1 - choose the one that matches your R version. You can check your R version by typing `R.Version()` in the R console.
If you don't have compiler tools installed, are uncertain if you do, or have trouble getting them to work then you can manually download a binary version of the `{aniMotum}` package for Windows or Intel Mac from here https://ianjonsen.r-universe.dev/ui#package:aniMotum. There are 3 binary versions for Windows & Mac, each corresponds to a different major release of R: 4.3 (development version), 4.2 (current version), and 4.1 (old version) - choose the one that matches your R version. You can check your R version by typing `R.Version()` in the R console.

When downloading the binary version on a Mac, it is important to right click and choose "Download Linked File As..." so that the file isn't automatically uncompressed. If you have downloaded the file correctly, its extension will be `.tgz`, **not** `.tar`. You can use the following command in the R console to install the file you've just downloaded (where `path_to_file` is wherever you saved the download):
```{r, eval=FALSE}
Expand All @@ -86,7 +86,7 @@ Then, click the "Browse" button to navigate to wherever you saved the `.zip` (Wi

![](man/figures/README-install_3.png){#id .class width=50% height=50%}

If you have a Mac with an M1 (or later) processor, the above binary file will not work as R-universe currently builds their Mac binaries on an Intel Mac. Instead, you will need to download the binary from here https://github.com/ianjonsen/aniMotum/releases/tag/v1.1-02. Follow the same installation procedure (R console or GUI) as above. Note, this binary was built for **R 4.2** releases. A version for **R 4.3** will be available soon.
If you have a Mac with an M1 (or later) processor, the above binary file will not work as R-universe currently builds their Mac binaries on an Intel Mac. Instead, you will need to download the binary from here https://github.com/ianjonsen/aniMotum/releases/tag/v1.1-02. Follow the same installation procedure (R console or GUI) as above. Note, this binary was built for **R 4.2.2**, the current release version.

### From GitHub (source)
If you prefer installing from GitHub via `remotes::install_github()` and know your way around the installation of compilers and associated libraries, then you will need to ensure you have the proper compilation tools and libraries installed.
Expand Down
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ have trouble getting them to work then you can manually download a
binary version of the `{aniMotum}` package for Windows or Intel Mac from
here <https://ianjonsen.r-universe.dev/ui#package:aniMotum>. There are 3
binary versions for Windows & Mac, each corresponds to a different major
release of R: 4.3, 4.2, and 4.1 - choose the one that matches your R
version. You can check your R version by typing `R.Version()` in the R
console.
release of R: 4.3 (development version), 4.2 (current version), and 4.1
(old version) - choose the one that matches your R version. You can
check your R version by typing `R.Version()` in the R console.

When downloading the binary version on a Mac, it is important to right
click and choose “Download Linked File As…” so that the file isn’t
Expand Down Expand Up @@ -128,8 +128,7 @@ will not work as R-universe currently builds their Mac binaries on an
Intel Mac. Instead, you will need to download the binary from here
<https://github.com/ianjonsen/aniMotum/releases/tag/v1.1-02>. Follow the
same installation procedure (R console or GUI) as above. Note, this
binary was built for **R 4.2** releases. A version for **R 4.3** will be
available soon.
binary was built for **R 4.2.2**, the current release version.

### From GitHub (source)

Expand Down

0 comments on commit 0fb1e17

Please sign in to comment.