@@ -26,7 +26,12 @@ Example: `$ git-sim merge <branch>`
2626- Animation only: Speed up or slow down animation speed as desired
2727
2828## 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 / environment:**
31+ - [ Install Manim on Windows] ( https://docs.manim.community/en/stable/installation/windows.html )
32+ - [ Install Manim on MacOS] ( https://docs.manim.community/en/stable/installation/macos.html )
33+ - [ Install Manim on Linux] ( https://docs.manim.community/en/stable/installation/linux.html )
34+ - [ Install Manim in Conda] ( https://docs.manim.community/en/stable/installation/conda.html )
3035
31362 ) Install ` git-sim ` :
3237
@@ -76,19 +81,19 @@ $ git-sim [global options] <subcommand> [subcommand options]
7681
7782The ` [global options] ` apply to the overarching ` git-sim ` simulation itself, including:
7883
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.
84+ ` --light-mode ` : Use a light mode color scheme instead of default dark mode.
85+ ` --animate ` : Instead of outputting a static image, animate the Git command behavior in a .mp4 video.
8186` --reverse ` : Display commit history in the reverse direction.
8287
8388Animation-only global options (to be used in conjunction with ` --animate ` ):
8489
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.
90+ ` --speed=n ` : Set the multiple of animation speed of the output simulation, ` n ` can be an integer or float, default is 1.
91+ ` --low-quality ` : Render the animation in low quality to speed up creation time, recommended for non-presentation use.
92+ ` --show-intro ` : Add an intro sequence with custom logo and title.
93+ ` --show-outro ` : Add an outro sequence with custom logo and text.
94+ ` --title=title ` : Custom title to display at the beginning of the animation.
95+ ` --logo=logo.png ` : The path to a custom logo to use in the animation intro/outro.
96+ ` --outro-top-text ` : Custom text to display above the logo during the outro.
9297` --outro-bottom-text ` : Custom text to display below the logo during the outro.
9398
9499The ` [subcommand options] ` are like regular Git options specific to the specified subcommand (see below for a full list).
@@ -275,7 +280,7 @@ $ git-sim stash
275280Simulate creating a new Git branch:
276281
277282``` console
278- $ git-sim branch new-branch-name
283+ $ git-sim branch new-branch-name
279284```
280285
281286Simulate creating a new Git tag:
0 commit comments