From 15e8f384215b88671915e533f662a23e98c1bd6f Mon Sep 17 00:00:00 2001 From: Dirk Eddelbuettel Date: Sun, 14 Mar 2021 21:18:14 -0500 Subject: [PATCH] note need for GH version of drat itself --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ab0c5b1f..ca435b1c 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,17 @@ accumulates more _code_ for `drat`, as well as ![](https://github.blog/wp-content/uploads/2016/08/47c2ecc4-6533-11e6-828a-91980daa7297.gif) - -This repo was initiated (using command `dratPackage()`) -with the source and windows binary of the last CRAN release of `drat`. You -can delete either or both (for example via command `pruneRepo()`) and then -add your own (via `insertPackage()`). +Note, however, that you currently **must** use the `drat` package directly +from its [GitHub repo](https://github.com/eddelbuettel/drat) in order to use +GitHub Pages off `docs/` in the main branch---and you need to enable this, +e.g. via `options(dratBranch="docs")` as the _released_ version only supports +a `gh-pages` branch. So in a sense this repo is currently "experimental" as +is the support in the not-yet-released `drat` version. + +This repo was initiated (using command `dratPackage()`) with the source and +windows binary of the last CRAN release of `drat`. You can delete either or +both (for example via command `pruneRepo()`) and then +add your own (via `insertPackage()`). ### Author