Skip to content

Commit 8cc5c53

Browse files
committed
update manim install link,
clean up some trailing whitespace
1 parent 1e9b8f6 commit 8cc5c53

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ 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](https://docs.manim.community/en/stable/installation.html)**
3031

3132
2) Install `git-sim`:
3233

@@ -76,19 +77,19 @@ $ git-sim [global options] <subcommand> [subcommand options]
7677

7778
The `[global options]` apply to the overarching `git-sim` simulation itself, including:
7879

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.
8182
`--reverse`: Display commit history in the reverse direction.
8283

8384
Animation-only global options (to be used in conjunction with `--animate`):
8485

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.
9293
`--outro-bottom-text`: Custom text to display below the logo during the outro.
9394

9495
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
275276
Simulate creating a new Git branch:
276277

277278
```console
278-
$ git-sim branch new-branch-name
279+
$ git-sim branch new-branch-name
279280
```
280281

281282
Simulate creating a new Git tag:

0 commit comments

Comments
 (0)