From d96a36245aa80c5e24ad9795924debc36e3780bd Mon Sep 17 00:00:00 2001
From: mloning <21020482+mloning@users.noreply.github.com>
Date: Sun, 24 Dec 2023 12:07:42 +0100
Subject: [PATCH] update docs

---
 .github/workflows/deploy.yaml | 2 +-
 README.md                     | 8 +++++---
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml
index 5eba537..0163111 100644
--- a/.github/workflows/deploy.yaml
+++ b/.github/workflows/deploy.yaml
@@ -1,5 +1,5 @@
 # Workflow for building and deploying a Hugo site to GitHub Pages
-name: Deploy Hugo site to Pages
+name: Deploy
 
 on:
   workflow_dispatch:
diff --git a/README.md b/README.md
index 4908603..4fb3b69 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,8 @@ My personal website built with [Hugo] and a modified [ezhil] theme.
 
 ## Local development
 
-* `git submodule update --init --recursive` to update the theme as a [git submodule]
+* `gh repo clone https://github.com/mloning/website . -- --recurse-submodules` to clone the repo with the theme as a [git submodule]
+* `git submodule update --init --recursive` to update the theme from the git submodule
 * `hugo server --verbose --buildDrafts --buildFuture --navigateToChanged` to start the Hugo server with hot reloading
 * `hugo new posts/<name>.md` to create a new draft in `content/posts/`
 
@@ -15,6 +16,7 @@ My personal website built with [Hugo] and a modified [ezhil] theme.
 
 ## Deploy 
 
-Deployed to GitHub Pages using GitHub Actions.
-
+Pushing changes to the `main` branch will trigger a deployment to [GitHub Pages] using a [GitHub Action].
 
+[GitHub Pages]: https://mloning.github.io/website/
+[GitHub Action]: https://github.com/mloning/website/actions/workflows/deploy.yaml