@@ -26,7 +26,8 @@ Example: `$ git-sim merge <branch>`
26
26
- Animation only: Speed up or slow down animation speed as desired
27
27
28
28
## Quickstart
29
- 1 ) ** Install [ manim and manim dependencies for your OS] ( https://www.manim.community/ ) **
29
+
30
+ 1 ) ** [ Install Manim and its dependencies for your OS] ( https://docs.manim.community/en/stable/installation.html ) **
30
31
31
32
2 ) Install ` git-sim ` :
32
33
@@ -76,19 +77,19 @@ $ git-sim [global options] <subcommand> [subcommand options]
76
77
77
78
The ` [global options] ` apply to the overarching ` git-sim ` simulation itself, including:
78
79
79
- ` --light-mode ` : Use a light mode color scheme instead of default dark mode.
80
- ` --animate ` : Instead of outputting a static image, animate the Git command behavior in a .mp4 video.
80
+ ` --light-mode ` : Use a light mode color scheme instead of default dark mode.
81
+ ` --animate ` : Instead of outputting a static image, animate the Git command behavior in a .mp4 video.
81
82
` --reverse ` : Display commit history in the reverse direction.
82
83
83
84
Animation-only global options (to be used in conjunction with ` --animate ` ):
84
85
85
- ` --speed=n ` : Set the multiple of animation speed of the output simulation, ` n ` can be an integer or float, default is 1.
86
- ` --low-quality ` : Render the animation in low quality to speed up creation time, recommended for non-presentation use.
87
- ` --show-intro ` : Add an intro sequence with custom logo and title.
88
- ` --show-outro ` : Add an outro sequence with custom logo and text.
89
- ` --title=title ` : Custom title to display at the beginning of the animation.
90
- ` --logo=logo.png ` : The path to a custom logo to use in the animation intro/outro.
91
- ` --outro-top-text ` : Custom text to display above the logo during the outro.
86
+ ` --speed=n ` : Set the multiple of animation speed of the output simulation, ` n ` can be an integer or float, default is 1.
87
+ ` --low-quality ` : Render the animation in low quality to speed up creation time, recommended for non-presentation use.
88
+ ` --show-intro ` : Add an intro sequence with custom logo and title.
89
+ ` --show-outro ` : Add an outro sequence with custom logo and text.
90
+ ` --title=title ` : Custom title to display at the beginning of the animation.
91
+ ` --logo=logo.png ` : The path to a custom logo to use in the animation intro/outro.
92
+ ` --outro-top-text ` : Custom text to display above the logo during the outro.
92
93
` --outro-bottom-text ` : Custom text to display below the logo during the outro.
93
94
94
95
The ` [subcommand options] ` are like regular Git options specific to the specified subcommand (see below for a full list).
@@ -275,7 +276,7 @@ $ git-sim stash
275
276
Simulate creating a new Git branch:
276
277
277
278
``` console
278
- $ git-sim branch new-branch-name
279
+ $ git-sim branch new-branch-name
279
280
```
280
281
281
282
Simulate creating a new Git tag:
0 commit comments