Skip to content

Commit

Permalink
docs: add screen recording of using template
Browse files Browse the repository at this point in the history
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 mojombo/github-flavored-markdown#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
  • Loading branch information
geoffreyvanwyk committed Jan 5, 2024
1 parent 5a5118f commit 0eb2b17
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
4 changes: 3 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"cSpell.words": [
"commitlint"
"asciicast",
"commitlint",
"Cookiecutter"
]
}
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 0eb2b17

Please sign in to comment.