Update readme

Author: Robinlovelace

README.md

@@ -1,19 +1,32 @@
+# Reproducible Road Safety Research with R
 
-<!-- README.md is generated from README.Rmd. Please edit that file -->
 
-# rrsrr
+<!-- README.md is generated from README.Rmd. Please edit that file -->
 
 <!-- badges: start -->
+
 <!-- badges: end -->
 
-To reproduce the contents of the book,
-[download](https://github.com/ITSLeeds/rrsrr/archive/master.zip) the
-source code from GitHub, open the file RStudio project file
-`rrsrr.Rproj` and run the following commands:
+This is a small practical textbook teaching building blocks for road
+safety research. See the rendered book, which is fully open access
+thanks to financial support from the RAC Foundation, at
+[itsleeds.github.io/rrsrr/](https://itsleeds.github.io/rrsrr/).
+
+To reproduce the contents of the book, clone the repo, e.g. with the
+following command after installing the GitHub CLI tool:
+
+``` sh
+gh repo clone ITSLeeds/rrsrr
+```
+
+or [download](https://github.com/ITSLeeds/rrsrr/archive/master.zip) the
+source code from GitHub. Open the folder with an IDE such as RStudio, VS
+Code, or Positron, and run the following commands:
 
 ``` r
-install.packages("remotes")
+# install dependencies (also see the DESCRIPTION file)
 remotes::install_github("itsleeds/rrsrr")
-install.packages("servr")
-bookdown::serve_book()
+# Install quarto (also requires the system dependency Quarto - see https://quarto.org/docs/get-started/)
+install.packages("quarto")
+quarto::quarto_preview()
 ```

README.qmd

@@ -1,5 +1,6 @@
 ---
-output: github_document
+format: gfm
+title: "Reproducible Road Safety Research with R"
 ---
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
@@ -13,24 +14,27 @@ knitr::opts_chunk$set(
 )
 ```
 
-# rrsrr
-
 <!-- badges: start -->
+
 <!-- badges: end -->
 
-To reproduce the contents of the book, [download](https://github.com/ITSLeeds/rrsrr/archive/master.zip) the source code from GitHub, open the file RStudio project file `rrsrr.Rproj` and run the following commands:
+This is a small practical textbook teaching building blocks for road safety research.
+See the rendered book, which is fully open access thanks to financial support from the RAC Foundation, at [itsleeds.github.io/rrsrr/](https://itsleeds.github.io/rrsrr/).
 
-```r
-install.packages("remotes")
-remotes::install_github("itsleeds/rrsrr")
-install.packages("servr")
-bookdown::serve_book()
-```
+To reproduce the contents of the book, clone the repo, e.g. with the following command after installing the GitHub CLI tool:
 
-```{r, eval=FALSE, echo=FALSE}
-setwd("..")
-zip(zipfile = "rrsrr.zip", files = "rrsrr")
-setwd("rrsrr")
+```sh
+gh repo clone ITSLeeds/rrsrr
 ```
 
+or [download](https://github.com/ITSLeeds/rrsrr/archive/master.zip) the source code from GitHub.
+Open the folder with an IDE such as RStudio, VS Code, or Positron, and run the following commands:
 
+```{r}
+#| eval: false
+# install dependencies (also see the DESCRIPTION file)
+remotes::install_github("itsleeds/rrsrr")
+# Install quarto (also requires the system dependency Quarto - see https://quarto.org/docs/get-started/)
+install.packages("quarto")
+quarto::quarto_preview()
+```