Skip to content

Commit f968e2d

Browse files
Update readme
Signed-off-by: Jacob Stopak <[email protected]>
1 parent e827d12 commit f968e2d

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Example: `$ git-sim merge <branch>`
2828
- Supported commands: `log`, `status`, `add`, `restore`, `commit`, `stash`, `branch`, `tag`, `reset`, `revert`, `merge`, `rebase`, `cherry-pick`
2929
- Generate an animated video (.mp4) instead of a static image using the `--animate` flag (note: significant performance slowdown, it is recommended to use `--low-quality` to speed up testing and remove when ready to generate presentation-quality video)
3030
- Choose between dark mode (default) and light mode
31+
- Specify output formats of either jpg, png, mp4, or webm
3132
- Animation only: Add custom branded intro/outro sequences if desired
3233
- Animation only: Speed up or slow down animation speed as desired
3334

@@ -120,7 +121,7 @@ The `[global options]` apply to the overarching `git-sim` simulation itself, inc
120121
Animation-only global options (to be used in conjunction with `--animate`):
121122

122123
`--video-format`: Output format for the video file, i.e. `mp4` or `webm`. Default output format is `mp4`.
123-
`--speed=n`: Set the multiple of animation speed of the output simulation, `n` can be an integer or float, default is 1.
124+
`--speed=n`: Set the multiple of animation speed of the output simulation, `n` can be an integer or float, default is 1.5.
124125
`--low-quality`: Render the animation in low quality to speed up creation time, recommended for non-presentation use.
125126
`--show-intro`: Add an intro sequence with custom logo and title.
126127
`--show-outro`: Add an outro sequence with custom logo and text.

git_sim/settings.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ class Settings(BaseSettings):
3636
show_intro = False
3737
show_outro = False
3838
speed = 1.5
39-
title = "Git Sim, by initialcommit.com"
39+
title = "Git-Sim, by initialcommit.com"
4040
video_format: VideoFormat = VideoFormat.mp4
4141
stdout = False
4242

0 commit comments

Comments
 (0)