Mirrors/ratatui
2
0
Fork 0
mirror of https://github.com/ratatui-org/ratatui synced 2024-11-10 07:04:17 +00:00
Code Issues Projects Releases Packages Wiki Activity

chore(demo): update demo gif (#234)

Browse source
This commit is contained in:
Orhun Parmaksız 2023-06-11 22:33:25 +02:00 committed by GitHub
parent 4a2ff204ec
commit de4f2b9990
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -16,7 +16,7 @@ Status](https://deps.rs/repo/github/tui-rs-revival/ratatui/status.svg?style=for-
[![Discord](https://img.shields.io/discord/1070692720437383208?label=discord&logo=discord&style=for-the-badge)](https://discord.gg/pMCEU9hNEj) [![Discord](https://img.shields.io/discord/1070692720437383208?label=discord&logo=discord&style=for-the-badge)](https://discord.gg/pMCEU9hNEj)
<!-- See RELEASE.md for instructions on creating the demo gif ---> <!-- See RELEASE.md for instructions on creating the demo gif --->
![Demo of Ratatui](https://vhs.charm.sh/vhs-IZKj0x97pI2LAJwxCpu1Y.gif) ![Demo of Ratatui](https://github.com/tui-rs-revival/ratatui/assets/24392180/93ab0e38-93e0-4ae0-a31b-91ae6c393185)
<details> <details>
<summary>Table of Contents</summary> <summary>Table of Contents</summary>

23
RELEASE.md
View file

@ -3,21 +3,22 @@
[crates.io](https://crates.io/crates/ratatui) releases are automated via [GitHub [crates.io](https://crates.io/crates/ratatui) releases are automated via [GitHub
actions](.github/workflows/cd.yml) and triggered by pushing a tag. actions](.github/workflows/cd.yml) and triggered by pushing a tag.
1. Record a new demo gif. I found the best tool for this was [ttyrec](http://0xcc.net/ttyrec/) and 1. Record a new demo gif. The preferred tool for this is [ttyrec](http://0xcc.net/ttyrec/) and
[ttygif](https://github.com/icholy/ttygif). Asciinema handles block character height poorly, [ttygif](https://github.com/icholy/ttygif). [Asciinema](https://asciinema.org/) handles block
termanilizer takes forever to render, [vhs](https://github.com/charmbracelet/vhs) handles braille character height poorly, [termanilizer](https://www.terminalizer.com/) takes forever to render,
[vhs](https://github.com/charmbracelet/vhs) handles braille
characters poorly (though if <https://github.com/charmbracelet/vhs/issues/322> is fixed, then characters poorly (though if <https://github.com/charmbracelet/vhs/issues/322> is fixed, then
it's probably the best option). it's probably the best option).
```shell ```shell
cargo build --example demo cargo build --example demo
ttyrec -e 'cargo --quiet run --release --example demo -- --tick-rate 100' demo.rec ttyrec -e 'cargo --quiet run --release --example demo -- --tick-rate 100' demo.rec
ttygif demo.rec ttygif demo.rec
``` ```
Then upload it somewhere (e.g. use `vhs publish tty.gif` to publish it or upload it to a github Then upload it somewhere (e.g. use `vhs publish tty.gif` to publish it or upload it to a GitHub
wiki page as an attachment). Avoid adding the gif to the git repo as binary files tend to bloat wiki page as an attachment). Avoid adding the gif to the git repo as binary files tend to bloat
repositories. repositories.
1. Bump the version in [Cargo.toml](Cargo.toml). 1. Bump the version in [Cargo.toml](Cargo.toml).
1. Ensure [CHANGELOG.md](CHANGELOG.md) is updated. [git-cliff](https://github.com/orhun/git-cliff) 1. Ensure [CHANGELOG.md](CHANGELOG.md) is updated. [git-cliff](https://github.com/orhun/git-cliff)