Skip to content

Commit 6508d2e

Browse files
authored
Update README.md (#26)
Update README to correct installation instructions using devtools. Adds instructions for installing tests as well. Closes #25
1 parent 3d2a6f4 commit 6508d2e

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,15 @@ conda install -c conda-forge r-gribr
4040
```shell
4141
R CMD INSTALL /path/to/gribr --configure-vars="ECCODES_CPPFLAGS=-I/path/to/eccodes/include ECCODES_LIBS=-L/path/to/eccodes/lib"
4242
```
43+
To install the tests, just add `--install-tests`.
4344
* _From within R or RStudio_:
4445
```R
4546
install.packages("path/to/cloned/gribr/repo", repos = NULL, configure.vars = c("ECCODES_LIBS=-L/path/to/eccodes/lib", "ECCODES_CPPFLAGS=-I/path/to/eccodes/include"))
4647
```
4748
```R
48-
devtools::install_github("nawendt/gribr", args = "--configure-args='ECCODES_LIBS=-L/path/to/eccodes/lib ECCODES_CPPFLAGS=-I/path/to/eccodes/include'")
49+
devtools::install_github("nawendt/gribr", configure.args="ECCODES_LIBS=-L/path/to/eccodes/lib ECCODES_CPPFLAGS=-I/path/to/eccodes/include")
4950
```
51+
Installing the tests through these methods requires adding `INSTALL_opts = "--install-tests"`.
5052

5153
### Windows Install Options
5254
While a native Windows ecCodes library that will work with R is not available, there are ways to run gribr on Windows. The first option is to use the [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/). Simply follow the [instructions](https://cran.r-project.org/bin/linux/ubuntu/) to install the latest R as you would on any other Linux system. Any other necessary libraries should be available on the package manager. Build gribr as usual and enjoy using it on Windows.

0 commit comments

Comments
 (0)