Skip to content

Commit

Permalink
docs(readme): upload demo gifs
Browse files Browse the repository at this point in the history
  • Loading branch information
a-kenji committed Jul 20, 2024
1 parent 41ffb53 commit 62d2d07
Show file tree
Hide file tree
Showing 13 changed files with 81 additions and 9 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,11 @@ Options:
Print help
```
For some types, the id will be automatically inferred.
![flake-edit add example](assets/tape/output/add_input.gif)
![flake-edit add example](https://vhs.charm.sh/vhs-iJiVTOvSd8V9WEl79Ie68.gif)

For some inputs, the uri can be put in directly and the id and type will be inferred.
![flake-edit add inferred example](assets/tape/output/add_input_inferred.gif)
![flake-edit add inferred example](https://vhs.charm.sh/vhs-3RsaCQO9CAznelPup2kDgV.gif
)

### `$ flake-edit remove`
`$ flake-edit help remove`
Expand All @@ -89,7 +90,7 @@ Options:
-h, --help
Print help
```
![flake-edit remove example](assets/tape/output/remove_input.gif)
![flake-edit remove example](https://vhs.charm.sh/vhs-1Uo70AaoEMuYh2UR1JVARD.gif)

### `$ flake-edit list`
`$ flake-edit help list`
Expand All @@ -105,9 +106,9 @@ Options:
Print help
```
List the outputs, that are specified inside the inputs attribute.
![flake-edit list example](assets/tape/output/list_inputs.gif)
![flake-edit list example](https://vhs.charm.sh/vhs-2ZSgdhkzBe3eoxuYtM1JL6.gif)
List the outputs, that are specified inside the inputs attribute, in json format.
![flake-edit list example](assets/tape/output/list_inputs_json.gif)
![flake-edit list example](https://vhs.charm.sh/vhs-35E6eiL63lFTSC70rQyE1Y.gif)


## License
Expand Down
2 changes: 1 addition & 1 deletion assets/tape/add_input.tape
Original file line number Diff line number Diff line change
Expand Up @@ -67,5 +67,5 @@ Type "set -x fish_function_path ''" Enter
Type "clear" Enter
Show

Type "fe add github:mic92/vmsh" Sleep 1000ms Enter
Type "flake-edit --diff add github:mic92/vmsh" Sleep 1000ms Enter
Sleep 5s
2 changes: 1 addition & 1 deletion assets/tape/add_input_inferred.tape
Original file line number Diff line number Diff line change
Expand Up @@ -67,5 +67,5 @@ Type "set -x fish_function_path ''" Enter
Type "clear" Enter
Show

Type "fe add https://github.com/nushell/nushell" Sleep 1000ms Enter
Type "flake-edit --diff add https://github.com/nushell/nushell" Sleep 1000ms Enter
Sleep 5s
2 changes: 1 addition & 1 deletion assets/tape/flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
inputs.flake-utils.follows = "flake-utils";
};
crane = {
url = "github:ipetkov/crane";
url = "github:ipetkov/crane?ref=0.1.6";
inputs = {
nixpkgs.follows = "nixpkgs";
rust-overlay.follows = "rust-overlay";
Expand Down
Empty file added assets/tape/output/.gitkeep
Empty file.
Binary file removed assets/tape/output/add_input.gif
Binary file not shown.
Binary file removed assets/tape/output/add_input_inferred.gif
Binary file not shown.
Binary file removed assets/tape/output/demo.gif
Binary file not shown.
Binary file removed assets/tape/output/list_inputs.gif
Binary file not shown.
Binary file removed assets/tape/output/list_inputs_json.gif
Binary file not shown.
Binary file removed assets/tape/output/remove_input.gif
Binary file not shown.
2 changes: 1 addition & 1 deletion assets/tape/remove_input.tape
Original file line number Diff line number Diff line change
Expand Up @@ -67,5 +67,5 @@ Type "set -x fish_function_path ''" Enter
Type "clear" Enter
Show

Type "fe rm crane" Sleep 1000ms Enter
Type "flake-edit --diff rm crane" Sleep 1000ms Enter
Sleep 5s
71 changes: 71 additions & 0 deletions assets/tape/update_input.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# VHS documentation
#
# Output:
# Output <path>.gif Create a GIF output at the given <path>
# Output <path>.mp4 Create an MP4 output at the given <path>
# Output <path>.webm Create a WebM output at the given <path>
#
# Require:
# Require <string> Ensure a program is on the $PATH to proceed
#
# Settings:
# Set FontSize <number> Set the font size of the terminal
# Set FontFamily <string> Set the font family of the terminal
# Set Height <number> Set the height of the terminal
# Set Width <number> Set the width of the terminal
# Set LetterSpacing <float> Set the font letter spacing (tracking)
# Set LineHeight <float> Set the font line height
# Set LoopOffset <float>% Set the starting frame offset for the GIF loop
# Set Theme <json|string> Set the theme of the terminal
# Set Padding <number> Set the padding of the terminal
# Set Framerate <number> Set the framerate of the recording
# Set PlaybackSpeed <float> Set the playback speed of the recording
# Set MarginFill <file|#000000> Set the file or color the margin will be filled with.
# Set Margin <number> Set the size of the margin. Has no effect if MarginFill isn't set.
# Set BorderRadius <number> Set terminal border radius, in pixels.
# Set WindowBar <string> Set window bar type. (one of: Rings, RingsRight, Colorful, ColorfulRight)
# Set WindowBarSize <number> Set window bar size, in pixels. Default is 40.
# Set TypingSpeed <time> Set the typing speed of the terminal. Default is 50ms.
#
# Sleep:
# Sleep <time> Sleep for a set amount of <time> in seconds
#
# Type:
# Type[@<time>] "<characters>" Type <characters> into the terminal with a
# <time> delay between each character
#
# Keys:
# Backspace[@<time>] [number] Press the Backspace key
# Down[@<time>] [number] Press the Down key
# Enter[@<time>] [number] Press the Enter key
# Space[@<time>] [number] Press the Space key
# Tab[@<time>] [number] Press the Tab key
# Left[@<time>] [number] Press the Left Arrow key
# Right[@<time>] [number] Press the Right Arrow key
# Up[@<time>] [number] Press the Up Arrow key
# Down[@<time>] [number] Press the Down Arrow key
# PageUp[@<time>] [number] Press the Page Up key
# PageDown[@<time>] [number] Press the Page Down key
# Ctrl+<key> Press the Control key + <key> (e.g. Ctrl+C)
#
# Display:
# Hide Hide the subsequent commands from the output
# Show Show the subsequent commands in the output

Output output/remove_input.gif

Require echo

Set Shell "fish"
Set FontSize 32
Set Width 1200
Set Height 600

Hide
#Type "echo 'Welcome to VHS!'" Sleep 500ms Enter
Type "set -x fish_function_path ''" Enter
Type "clear" Enter
Show

Type "fe --diff update" Sleep 1000ms Enter
Sleep 5s

0 comments on commit 62d2d07

Please sign in to comment.