Skip to content

Commit

Permalink
Merge pull request #76 from inbo/readme
Browse files Browse the repository at this point in the history
pkgdown website: add quick installation method
  • Loading branch information
florisvdh authored Jan 12, 2021
2 parents 8f21b66 + e648572 commit e115f31
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 9 deletions.
25 changes: 16 additions & 9 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,26 @@
addons:
apt:
sources:
- sourceline: 'ppa:ubuntugis/ubuntugis-unstable'
packages:
- libudunits2-dev
- libgdal-dev
- libproj-dev
- libgeos-dev
- libfftw3-dev
- libfribidi-dev

language: r

dist: bionic

cache: packages

r_packages:
- pkgdown

r_github_packages:
- inbo/inborutils

apt_packages:
- libudunits2-dev # For inborutils
- libgdal1-dev # For inborutils
- libfftw3-dev # For watina

after_success:
- R CMD INSTALL . # Install the package to build vignettes
- R CMD INSTALL .
- Rscript -e "pkgdown::build_site(preview = FALSE)"

deploy:
Expand Down
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,17 @@ Currently the R package won't work outside INBO.

## Installing, testing and using the _watina_ package

### Option 1 (quick): installing without vignettes

```r
Sys.setenv(R_REMOTES_NO_ERRORS_FROM_WARNINGS = "true") # as a precaution
remotes::install_github("inbo/watina", upgrade = TRUE)
```

You can consult the vignettes of the latest release on the (this) `pkgdown` [website](https://inbo.github.io/watina/): click on 'Articles' at the top.

### Option 2: installing with vignettes

```r
Sys.setenv(R_REMOTES_NO_ERRORS_FROM_WARNINGS = "true") # as a precaution
if (!("nycflights13" %in% installed.packages())) {
Expand Down

0 comments on commit e115f31

Please sign in to comment.