mirror of
https://github.com/ratatui/ratatui.git
synced 2025-09-29 22:11:34 +00:00
c0991cc576
* docs: make library and README consistent Generate the bulk of the README from the library documentation, so that they are consistent using cargo-rdme. - Removed the Contributors section, as it is redundant with the github contributors list. - Removed the info about the other backends and replaced it with a pointer to the documentation. - add docsrs example, vhs tape and images that will end up in the README Fixes: https://github.com/ratatui-org/ratatui/issues/512
40 lines
962 B
VHS
40 lines
962 B
VHS
# This is a vhs script. See https://github.com/charmbracelet/vhs for more info.
|
|
# To run this script, install vhs and run `vhs ./examples/demo.tape`
|
|
# NOTE: Requires VHS 0.6.1 or later for Screenshot support
|
|
Output "target/docsrs.gif"
|
|
Set Theme "OceanicMaterial"
|
|
# The reason for this strange size is that the social preview image for this
|
|
# demo is 1280x64 with 80 pixels of padding on each side. We want a version
|
|
# without the padding for README.md, etc.
|
|
Set Width 640
|
|
Set Height 160
|
|
Set Padding 0
|
|
Hide
|
|
Type "cargo run --example docsrs --features crossterm"
|
|
Enter
|
|
Sleep 2s
|
|
Show
|
|
Sleep 1s
|
|
Screenshot "target/docsrs-hello.png"
|
|
Sleep 1s
|
|
Hide
|
|
Type "q"
|
|
Type "cargo run --example docsrs --features crossterm -- layout"
|
|
Enter
|
|
Sleep 2s
|
|
Show
|
|
Sleep 1s
|
|
Screenshot "target/docsrs-layout.png"
|
|
Sleep 1s
|
|
Hide
|
|
Type "q"
|
|
Type "cargo run --example docsrs --features crossterm -- styling"
|
|
Enter
|
|
Sleep 2s
|
|
Show
|
|
Sleep 1s
|
|
Screenshot "target/docsrs-styling.png"
|
|
Sleep 1s
|
|
Hide
|
|
Type "q"
|