Correctly update README.qmd, not README.md

Author: chriscarrollsmith

README.md

@@ -25,21 +25,25 @@ less efficient than a partial page update on the client side.
 
 ### Install development dependencies in a VSCode Dev Container
 
-If you use VSCode with Docker, the following VSCode Dev Container configuration will install all dependencies and automatically open the project in a container:
+If you use VSCode with Docker, the following VSCode Dev Container
+configuration will install all dependencies and automatically open the
+project in a container:
 
 ``` json
 {
-	"name": "Python 3",
-	"image": "mcr.microsoft.com/devcontainers/python:1-3.12-bullseye",
-	"postCreateCommand": "sudo apt update && sudo apt install -y python3-dev libpq-dev graphviz && pipx install poetry && poetry install && poetry shell",
-	"features": {
-		"ghcr.io/devcontainers/features/docker-outside-of-docker:1": {},
-		"ghcr.io/rocker-org/devcontainer-features/quarto-cli:1": {}
-	}
+    "name": "Python 3",
+    "image": "mcr.microsoft.com/devcontainers/python:1-3.12-bullseye",
+    "postCreateCommand": "sudo apt update && sudo apt install -y python3-dev libpq-dev graphviz && pipx install poetry && poetry install && poetry shell",
+    "features": {
+        "ghcr.io/devcontainers/features/docker-outside-of-docker:1": {},
+        "ghcr.io/rocker-org/devcontainer-features/quarto-cli:1": {}
+    }
 }
 ```
 
-Simply create a .devcontainer folder in the root of the project and add a devcontainer.json file with this content, and then "Reopen in Container" from View > Command Palette.
+Simply create a .devcontainer folder in the root of the project and add
+a devcontainer.json file with this content, and then “Reopen in
+Container” from View \> Command Palette.
 
 ### Install development dependencies manually
 
@@ -70,7 +74,6 @@ For Windows:
 
 - [Quarto CLI](https://quarto.org/docs/get-started/)
 
-
 For macOS:
 
 ``` bash
@@ -85,7 +88,8 @@ sudo apt update && sudo apt install -y graphviz
 
 For Windows:
 
-- Download and install from [Graphviz.org](https://graphviz.org/download/#windows)
+- Download and install from
+  [Graphviz.org](https://graphviz.org/download/#windows)
 
 #### Python dependencies
 

README.qmd

@@ -50,50 +50,87 @@ dot.render('static/webapp_flow', format='png', cleanup=True)
 
 The advantage of the PRG pattern is that it is very straightforward to implement and keeps most of the rendering logic on the server side. The disadvantage is that it requires an extra round trip to the database to fetch the updated data, and re-rendering the entire page template may be less efficient than a partial page update on the client side.
 
-### Install development dependencies
+### Install development dependencies in a VSCode Dev Container
+
+If you use VSCode with Docker, the following VSCode Dev Container configuration will install all dependencies and automatically open the project in a container:
+
+``` json
+{
+	"name": "Python 3",
+	"image": "mcr.microsoft.com/devcontainers/python:1-3.12-bullseye",
+	"postCreateCommand": "sudo apt update && sudo apt install -y python3-dev libpq-dev graphviz && pipx install poetry && poetry install && poetry shell",
+	"features": {
+		"ghcr.io/devcontainers/features/docker-outside-of-docker:1": {},
+		"ghcr.io/rocker-org/devcontainer-features/quarto-cli:1": {}
+	}
+}
+```
+
+Simply create a .devcontainer folder in the root of the project and add a devcontainer.json file with this content, and then "Reopen in Container" from View > Command Palette.
+
+### Install development dependencies manually
 
-#### Python, Docker, and Quarto CLI
+#### Python and Docker
 
 - [Python 3.12 or higher](https://www.python.org/downloads/)
 - [Docker and Docker Compose](https://docs.docker.com/get-docker/)
-- [Quarto CLI](https://quarto.org/docs/get-started/)
 
 #### PostgreSQL headers
 
 For Ubuntu/Debian:
 
-```bash
+``` bash
 sudo apt update && sudo apt install -y python3-dev libpq-dev
 ```
 
 For macOS:
 
-```bash
+``` bash
 brew install postgresql
 ```
 
 For Windows:
 
-- No additional system dependencies required
-- Install Python from the official Python website
+- No installation required
+
+#### Quarto CLI and Graphviz
+
+- [Quarto CLI](https://quarto.org/docs/get-started/)
+
+
+For macOS:
+
+``` bash
+brew install graphviz
+```
+
+For Ubuntu/Debian:
+
+``` bash
+sudo apt update && sudo apt install -y graphviz
+```
+
+For Windows:
+
+- Download and install from [Graphviz.org](https://graphviz.org/download/#windows)
 
 #### Python dependencies
 
-1. Install Poetry
+1.  Install Poetry
 
-```bash
+``` bash
 pipx install poetry
 ```
 
-2. Install project dependencies
+2.  Install project dependencies
 
-```bash
+``` bash
 poetry install
 ```
 
-3. Activate shell
+3.  Activate shell
 
-```bash
+``` bash
 poetry shell
 ```
 
@@ -127,7 +164,11 @@ Navigate to http://localhost:8000/
 
 ### Render the README
 
-`quarto render README.qmd`
+When updating the documentation, remember to make changes in the README.qmd file, not the README.md file. Then run the following command to render the README.md file:
+
+``` bash
+quarto render README.qmd
+```
 
 ### Contributing