Skip to content

docs[readme]: add note about inline comments in tape file #684

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
0xjuanma wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs[readme]: add note about inline comments in tape file #684

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ Tape files consist of a series of [commands](#vhs-command-reference). The comman
instructions for VHS to perform on its virtual terminal. For a list of all
possible commands see [the command reference](#vhs-command-reference).

> [!NOTE]
> You can include inline comments in your tape file by starting a line with `#`.

```elixir
# Where should we write the GIF?
Output demo.gif
Expand Down