From 0eb2b173726b6abce613a8f23d051a4c61b4a517 Mon Sep 17 00:00:00 2001
From: Geoffrey van Wyk <geoffrey@vanwyk.biz>
Date: Fri, 5 Jan 2024 17:06:51 +0200
Subject: [PATCH] docs: add screen recording of using template

Add the screen recording to the README.md file as an image displaying a
screenshot of the recording that links to https://asciinema.org where
the screen recording can be played. The screen recording itself cannot
be embedded in the README.md because GitHub does not allow `script` HTML
tags.

The link cannot be opened in a new tab because GitHub Markdown does not support
it. See https://github.com/mojombo/github-flavored-markdown/issues/28

Using `svg-term-cli` to create an animated SVG does not work, because it
does not play smoothly and does not use the settings applied to the cast
on asciinema.org.

Update dictionary for VS Code workspace to fix spelling errors.

Issues: #11
---
 .vscode/settings.json | 4 +++-
 README.md             | 5 ++++-
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/.vscode/settings.json b/.vscode/settings.json
index d5c2bb0..1c25a22 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -1,5 +1,7 @@
 {
     "cSpell.words": [
-        "commitlint"
+        "asciicast",
+        "commitlint",
+        "Cookiecutter"
     ]
 }
\ No newline at end of file
diff --git a/README.md b/README.md
index 8c427f8..aab3550 100644
--- a/README.md
+++ b/README.md
@@ -19,13 +19,16 @@ A [cookiecutter](https://cookiecutter.readthedocs.io/en/stable/) for
 
 ## Usage
 
+[![asciicast](https://asciinema.org/a/630021.svg)](https://asciinema.org/a/630021)
+
 Install the `pip` package manager for Python.
 
 ```shell
 sudo apt install --yes python3-pip
 ```
 
-Install the Cookiecutter package.
+Install the Cookiecutter package (preferably create a Python virtual environment
+beforehand).
 
 ```shell
 pip install cookiecutter