Update README to match template.

README.md

@@ -1,10 +1,15 @@
 # Workshop: R Basics
 
-_[UC Davis DataLab](https://datalab.ucdavis.edu/)_  
+_[UC Davis DataLab][datalab]_  
 _Fall 2024_  
 _Instructors: Michele Tobias, Wesley Brooks_  
 _Maintainer: Nick Ulle <<[email protected]>>_
 
+The reader for this workshop is [here][reader].
+
+[datalab]: https://datalab.ucdavis.edu/
+[reader]: https://ucdavisdatalab.github.io/workshop_r_basics/
+
 This 4-part workshop series provides an introduction to using the R programming
 language for reproducible data analysis and scientific computing. Topics
 include programming basics, how to work with tabular data, how to break down
@@ -18,59 +23,70 @@ No prior programming experience is necessary. All learners will need access to
 an internet-connected computer and the latest version of Zoom, R, and RStudio.
 
 
-## Common Links
-
-* [Reader](https://ucdavisdatalab.github.io/workshop_r_basics/)
-* Event Page
-
-
 ## Contributing
 
-The course reader is a live webpage, hosted through GitHub, where you can enter
-curriculum content and post it to a public-facing site for learners.
+The workshop reader is written in Markdown and rendered with [Quarto][]. To
+modify the reader:
 
-To make alterations to the reader:
+1.  If it's your first time contributing, start with [Setup](#setup).
 
-1.  Check in with the reader's current maintainer and notify them about your 
-    intended changes. Maintainers might ask you to open an issue, use pull 
-    requests, tag your commits with versions, etc.
+2.  Talk to the reader's maintainer about your intended changes. The
+    maintainer might ask you to consult existing issues, make pull requests,
+    tag your commits with versions, etc.
 
-2.  Run `git pull`, or if it's your first time contributing, see the
-    [Setup](#setup) section of this document.
+3.  Run `git pull` to make sure you have the latest changes.
 
 3.  Edit an existing chapter file or create a new one. Chapter files are in the
-    `chapters/` directory and are Quarto Markdown files (`.qmd`). Enter your
-    text, code, and other information directly into the file. Make sure your
-    file:
+    `chapters/` directory and are Quarto Markdown files (`.qmd`). Chapter files
+    should:
 
-    - Follows the naming scheme `##_topic-of-chapter.qmd`.
-    - Begins with a first-level header (like `# This`). This will be the title
+    * Follow the file naming scheme `##_title-of-chapter.qmd` (for numbered
+      chapters) or `title-of-chapter.qmd` (for unnumbered chapters).
+    * Begin with a first-level header (like `# This`). This will be the title
       of your chapter. Subsequent section headers should be second-level
       headers (like `## This`) or below.
 
-    Put any supporting resources in `data/` or `images/`. Store large files in
-    Google Drive or other cloud storage rather than committing them to the
-    repo. You do not need to add generated resources (such as HTML files). The
-    render step saves these in `docs/` automatically.
+    Put any supporting resources in `data/` or `images/`. Store large files (>
+    1 MB), such as data sets, on Google Drive, Box, or other cloud storage
+    rather than GitHub.
+
+4.  Run `quarto render` to render the reader (the files in `docs/`). This can
+    be time-consuming; if you're not done editing and just want a quick
+    preview, you can use `quarto preview` instead.
+
+5.  When you're finished editing, run `git add` on:
 
-4.  In a terminal, navigate to this repo and run `quarto render` to re-render
-    the website (the files in `docs/`).
+    * Any `.qmd` files you added or edited in `chapters/`
+    * Any image files you added or edited in `images/`
+    * The entire `_freeze/` directory
+    * Any other files you added or edited
 
-5.  When you're finished, `git add`:
-    - Any files you edited directly
-    - Any supporting media you added to `docs/` or `images/`
-    - The entire `docs/` directory
-    - The entire `_freeze/` directory
+    Then run `git commit` to save the files and `git push` to upload them to
+    GitHub.
 
-    Then `git commit` and `git push`. The live web page will update
-    automatically after 1-10 minutes.
+The reader is hosted by GitHub Pages as a live, public website. The files for
+the website are stored in `docs/` on branch `main`. To update the website:
+
+1.  Run `quarto render` to render the reader (the files in `docs/`).
+
+2.  Run `git add docs/`, then `git commit` and `git push`.
+
+Then the website will update automatically after a few minutes.
 
 
 ## Setup
 
-This project uses [Quarto][]. Make sure it is installed before rendering the
-reader.
+The reader is rendered with [Quarto][]. Make sure it's installed before
+rendering the reader.
 
 [Quarto]: https://quarto.org/
 
-[Back to Top](#workshop-r-basics)
+The reader might also depend on specific R packages. If the maintainer has
+opted to use [renv][], open R in this repo and run `renv::restore()` to install
+them. If not, you'll have to use trial-and-error to determine which packages to
+install.
+
+[renv]: https://rstudio.github.io/renv/
+
+
+([back to top](#workshop-r-basics))