Skip to content

Commit 551d3d7

Browse files
committed
docs(README): document the -b and -d a bit
1 parent f2ee796 commit 551d3d7

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Blazingly fast terminal recorder that generates animated gif images for the web
1515
- Screenshotting your terminal with 4 frames per second (every 250ms)
1616
- Generates high quality small sized animated gif images
1717
- **Build-In idle frames detection and optimization** (for super fluid presentations)
18+
- Applies (can be disabled) border decor effects like drop shadow
1819
- Runs (only) on MacOS
1920
- Uses native efficient APIs
2021
- Runs without any cloud service and entirely offline
@@ -36,7 +37,7 @@ Blazingly fast terminal recorder that generates animated gif images for the web
3637

3738
### with cargo
3839

39-
**NOTE** for now `t-rec` depends on `imagemagick`.
40+
**NOTE** `t-rec` depends on `imagemagick`.
4041

4142
```sh
4243
❯ brew install imagemagick
@@ -78,6 +79,8 @@ FLAGS:
7879
-v, --verbose Enable verbose insights for the curious.
7980

8081
OPTIONS:
82+
-b, --bg <bg> Background color when decors are used [default: white] [possible values: white, black,
83+
transparent]
8184
-d, --decor <decor> Decorates the animation with certain, mostly border effects. [default: shadow] [possible
8285
values: shadow, none]
8386

@@ -92,6 +95,11 @@ If you are not happy with the idle detection and optimization, you can disable i
9295
By doing so, you would get the very natural timeline of typing and recording as you do it.
9396
In this case there will be no optimizations performed.
9497
98+
### Disable shadow border decor
99+
100+
In order to disable the drop shadow border decor you have to pass `-p none` as an argument. If your only want to change
101+
the color of the background you can use `-b black` for example to have a black background.
102+
95103
## Hidden Gems
96104
97105
You can record not only the terminal but also every other window. There 2 ways to do so:

0 commit comments

Comments
 (0)