From 3be08d187cb885b6fe0fe9d57f4950a5ff409a5c Mon Sep 17 00:00:00 2001
From: mpadge <mark.padgham@email.com>
Date: Wed, 20 Mar 2024 14:12:01 +0100
Subject: [PATCH] add readme

---
 DESCRIPTION   |  2 +-
 README.md     | 30 ++++++++++++++++++++++++++++++
 codemeta.json |  2 +-
 3 files changed, 32 insertions(+), 2 deletions(-)
 create mode 100644 README.md

diff --git a/DESCRIPTION b/DESCRIPTION
index 83f422c..fbfb8e7 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: dashboard
 Title: What the Package Does (One Line, Title Case)
-Version: 0.0.10.008
+Version: 0.0.11
 Authors@R: 
   person(given = "First",
          family = "Last",
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7a12c24
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+
+# rOpenSci Software Review Dashboard
+
+This repository contains the source code for [rOpenSci's *Software Review
+Dashboard*](https://ropensci-review-tools.github.io/dashboard). This includes
+both a local R package named "dashboard", and a [quarto
+directory](https://github.com/ropensci-review-tools/dashboard/tree/main/quarto)
+which includes the source files for the website. This README is intended only
+for developers. Anybody solely interested in the dashboard should [head
+straight to the website](https://ropensci-review-tools.github.io/dashboard).
+
+## renv and local usage
+
+The quarto website uses [`renv`](https://rstudio.github.io/renv/) to manage
+package dependencies in the [GitHub
+workflow](https://github.com/ropensci-review-tools/dashboard/blob/main/.github/workflows/publish.yaml).
+The environment will be automatically built the first time R is started in the
+root directory of this repository. This environment will nevertheless not
+include the package itself, and so the package needs to be manually installed
+using:
+
+``` r
+remotes::install_github ("ropensci-review-tools/dashboard")
+```
+
+The website can be locally previewed by running `quarto preview` in the
+`quarto` directory, using the locally-installed version of the "dashboard"
+package. This means that any updates to the package itself will only be
+rendered on the quarto website once those changes have been pushed and the
+package locally re-installed using the `install_github` command above.
diff --git a/codemeta.json b/codemeta.json
index 6f04ed9..5d44171 100644
--- a/codemeta.json
+++ b/codemeta.json
@@ -6,7 +6,7 @@
   "name": "dashboard: What the Package Does (One Line, Title Case)",
   "codeRepository": "https://github.com/ropensci-review-tools/dashboard",
   "license": "https://spdx.org/licenses/MIT",
-  "version": "0.0.10.008",
+  "version": "0.0.11",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",