From 6d5a748657abd76c1d2ffe8b7268a8a7bd7a7588 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 30 Nov 2022 18:18:55 +0000 Subject: [PATCH] [actions skip] Add/Update README.md for pre-release --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b42b2472..69eaf654 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ ADaM in R Asset Library Development Utilities + ## Purpose @@ -13,26 +14,29 @@ Tools for developing functions and maintaining a healthy code base within the family of admiral R packages. `{admiraldev}` is intended to be used when developing `{admiral}` or `{admiral}` extension packages. -**NOTE:** Use of this package as a standalone package is currently not -recommended. +__NOTE:__ This package is not intended for standalone use but rather as +a central dependency for all developer utilities of `{admiral}` and its +extension packages ## Installation The package is available from CRAN and can be installed by running -install.packages(“admiraldev”). +`install.packages("admiraldev")`. To install the latest development version of the package directly from GitHub use the following code: - if (!requireNamespace("remotes", quietly = TRUE)) { - install.packages("remotes") - } +``` +if (!requireNamespace("remotes", quietly = TRUE)) { + install.packages("remotes") +} - remotes::install_github("pharmaverse/admiraldev", ref = "devel") +remotes::install_github("pharmaverse/admiraldev", ref = "devel") +``` ## Release Schedule -`{admiraldev}` is to be official released to CRAN one week before the -release of `{admiral}`. You can find the release schedule for +`{admiraldev}` is to be officially released to CRAN one week before an +official release of `{admiral}`. You can find the release schedule for `{admiral}` packages -[here](https://github.com/pharmaverse/admiral/tree/devel#release-schedule). +[here](https://pharmaverse.github.io/admiral/#release-schedule).