Skip to content

Commit

Permalink
Add demo gif and vhs tape file
Browse files Browse the repository at this point in the history
Signed-off-by: Nana Kwadwo <agyemang.nana.b@gmail.com>
  • Loading branch information
bxffour authored and alexellis committed Oct 6, 2023
1 parent b8cb09c commit 5e98716
Show file tree
Hide file tree
Showing 3 changed files with 98 additions and 0 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,35 @@ Example:
}
```

### Edit and Generate demo GIF

To add an entry to the demo GIF:
- Open the `docs/arkade.tape` file in your preferred text editor.
- Insert your desired commands according to the following format

```
Type@50ms "# Short decription of what the command does" Sleep <duration>
Hide
Ctrl+C
Show
Type "<command>" Enter Sleep <duration>
Hide
Type "clear" Enter
Show
```

- Generate the GIF file.

```bash
$ vhs docs/arkade.tape
```

- Publish the GIF to get a shareable URL
```bash
$ vhs publish arkade.gif
```

### Workflow for a first-time contributing

Here's the basics for contributing:
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,10 @@ Or get a copy of his eBook on Go so you can learn how to build tools like k3sup,
>
> [John Arundel](https://twitter.com/bitfield/status/1242385165445455872?s=20) - Cloud consultant, author
## Demo

![demo](https://vhs.charm.sh/vhs-7Fyg69mwbYHFuUtSKnWMYT.gif)

## Getting arkade

```bash
Expand Down
65 changes: 65 additions & 0 deletions docs/arkade.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
Output arkade.gif

Set FontSize 20
Set Shell zsh
Set Width 1200
Set Height 600
Set TypingSpeed 100ms
Set WindowBar Colorful


# Downloading a CLI Binary
Type@50ms "# Download a CLI Binary with arkade get" Sleep 2s
Hide
Ctrl+C
Show

Type "arkade get jq" Enter Sleep 8s
Type "jq --version" Enter Sleep 2s
Hide
Type "clear" Enter
Show

# Specifying the version of the CLI
Type@50ms "# Download a specific version of a CLI" Sleep 2s
Hide
Ctrl+C
Show

Type "arkade get kind@v0.19.0" Enter Sleep 8s
Type "kind version" Enter Sleep 2s
Hide
Type "clear" Enter
Show

# Downloading the multiple CLIs
Type@50ms "# Download multiple CLIs" Sleep 2s
Hide
Ctrl+C
Show

Type "arkade get k3sup@0.12.12 viddy" Enter Sleep 15s
Hide
Type "clear" Enter
Show

# Downloading and Installing system binaries
Type@50ms "# Download and Install a system binary" Sleep 2s
Hide
Ctrl+C
Show

# Hack to run command with sudo on VHS tape
#
# Running a command with sudo on a VHS tape can be tricky. To work around this,
# you can edit the /etc/sudoers file to not require passwords for the user
# temporarily or create a hidden command that runs a sudo command and enters the
# password before the actual command.
Type "sudo arkade system install firecracker" Enter Sleep 8s
Type "firecracker --version" Enter Sleep 2s
Hide
Type "clear" Enter
Show

# Closing message
Type "Try arkade out now to see how easy it is to install your favourite tools." Enter Sleep 2s

0 comments on commit 5e98716

Please sign in to comment.