doc: install from CRAN

FRBCesab · Oct 16, 2023 · 8506b8b · 8506b8b
1 parent f2aa5fc
commit 8506b8b
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 8 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -102,12 +102,24 @@ Blanchet _et al._ 2008), methods available in the package
 
 ## Installation
 
-The package is not yet published on the CRAN but you can install the development
-version from GitHub with:
+You can install the stable version from [CRAN](https://cran.r-project.org/) with:
 
 ```{r eval=FALSE}
-# install.packages("remotes")
-remotes::install_github("frbcesab/chessboard")
+## Install stable version of < chessboard > from CRAN ----
+install.packages("chessboard")
+```
+
+
+Or you can install the development version from [GitHub](https://github.com/) with:
+
+```{r eval=FALSE}
+## Install < remotes > package (if not already installed) ----
+if (!requireNamespace("remotes", quietly = TRUE)) {
+  install.packages("remotes")
+}
+
+## Install dev version of < chessboard > from GitHub ----
+remotes::install_github("FRBCesab/chessboard")
 ```
 
 Then you can attach the package `chessboard`:

diff --git a/README.md b/README.md
@@ -95,12 +95,25 @@ al.* 2023):
 
 ## Installation
 
-The package is not yet published on the CRAN but you can install the
-development version from GitHub with:
+You can install the stable version from
+[CRAN](https://cran.r-project.org/) with:
 
 ``` r
-# install.packages("remotes")
-remotes::install_github("frbcesab/chessboard")
+## Install stable version of < chessboard > from CRAN ----
+install.packages("chessboard")
+```
+
+Or you can install the development version from
+[GitHub](https://github.com/) with:
+
+``` r
+## Install < remotes > package (if not already installed) ----
+if (!requireNamespace("remotes", quietly = TRUE)) {
+  install.packages("remotes")
+}
+
+## Install dev version of < chessboard > from GitHub ----
+remotes::install_github("FRBCesab/chessboard")
 ```
 
 Then you can attach the package `chessboard`: