Skip to content

Commit

Permalink
docs: update example list
Browse files Browse the repository at this point in the history
  • Loading branch information
MrMarble committed Feb 14, 2024
1 parent c66abc5 commit a9f116c
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,30 @@
This folder contains some examples of recordings and exports.
It's intended to be used as a demonstration of features and also to track the file size.

| Example | Description |
|----------------------------|------------------------------------------------------------------------------------------|
| [256colors](256colors.svg) | script to print the 256 xterm colors as background and foreground |
| [htop](htop.svg) | running htop to see progress bars, headers and pagination |
| [session](session.svg) | simple terminal session running various commands like ls and cat |
| [444816](444816.svg) | Asciicast recording of an equilibrium pendulum to see compatibility with asciinema files |
| Example | Description |
| ------------------------------------------ | ---------------------------------------------------------------------------------------- |
| [256colors](256colors.svg) | script to print the 256 xterm colors as background and foreground |
| [htop](htop.svg) | running htop to see progress bars, headers and pagination |
| [session](session.svg) | simple terminal session running various commands like ls and cat |
| [444816](444816.svg) | Asciicast recording of an equilibrium pendulum to see compatibility with asciinema files |
| [444816 borderless](444816_borderless.svg) | Same as 444816 but without a terminal window |

> Files are not embedded here to alleviate loading

## Sizes

This table tracks size changes between the first release of the example and the last one as examples are updated on each code change to reflect new features and optimizations.

<!--SIZES_START-->
| File | Iterations | First Size | Current Size | Variation |
|---------------|:----------:|------------|--------------|-----------|
| 256colors.svg | 2 | 954,73KB | 950,15KB | .4800% |
| 444816.svg | 6 | 3,42MB | 2,92MB | 15.6300% |
| htop.svg | 4 | 74,15KB | 63,35KB | 15.7000% |
| session.svg | 5 | 462,64KB | 391,84KB | 16.5700% |

| File | Iterations | First Size | Current Size | Variation |
| --------------------- | :--------: | ---------- | ------------ | --------- |
| 256colors.svg | 2 | 954.73KB | 950.15KB | .4800% |
| 444816.svg | 6 | 3.42MB | 2.92MB | 15.6300% |
| 444816_borderless.svg | 2 | 3.11MB | 2.92MB | 6.1700% |
| htop.svg | 4 | 74.15KB | 63.35KB | 15.7000% |
| session.svg | 5 | 462.64KB | 391.84KB | 16.5700% |

<!--SIZES_END-->
> Table generated using [update-filesize.sh](/scripts/update-filesize.sh) script

> Table generated using [update-filesize.sh](/scripts/update-filesize.sh) script

0 comments on commit a9f116c

Please sign in to comment.