Skip to content

Commit 6a5f0bd

Browse files
Update README.md
1 parent 6129418 commit 6a5f0bd

File tree

1 file changed

+29
-4
lines changed

1 file changed

+29
-4
lines changed

README.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ $ cd path/to/project/root
5252
$ git-story
5353
```
5454

55-
5) A default animation `.mp4` file will be created using the most recent 8 commits on your checked-out Git branch.
55+
5) A default animation `.mp4` file will be created using the most recent 8 commits on your checked-out Git branch. By default, video output file is created in the current directory, within a subdirectory called `git-story_media`. The location this subdirectory is customizeable using the command line flag `--media-dir=path/to/output`.
5656

5757
6) Use command-line options for customization, see usage:
5858

@@ -70,17 +70,21 @@ optional arguments:
7070
--hide-merged-chains Hide commits from merged branches, i.e. only display mainline commits (default: False)
7171
--reverse Display commits in reverse order in the Git animation (default: False)
7272
--title TITLE Custom title to display at the beginning of the animation (default: Git Story, by initialcommit.com)
73-
--logo LOGO The path to a custom logo to use in the animation intro/outro (default: logo.png)
73+
--logo LOGO The path to a custom logo to use in the animation intro/outro (default: /usr/local/lib/python3.9/site-packages/git_story/logo.png)
7474
--outro-top-text OUTRO_TOP_TEXT
7575
Custom text to display above the logo during the outro (default: Thanks for using Initial Commit!)
7676
--outro-bottom-text OUTRO_BOTTOM_TEXT
7777
Custom text to display below the logo during the outro (default: Learn more at initialcommit.com)
78-
--no-intro Omit the intro sequence from the animation (default: False)
79-
--no-outro Omit the outro sequence from the animation (default: False)
78+
--show-intro Add an intro sequence with custom logo and title (default: False)
79+
--show-outro Add an outro sequence with custom logo and text (default: False)
8080
--max-branches-per-commit MAX_BRANCHES_PER_COMMIT
8181
Maximum number of branch labels to display for each commit (default: 2)
8282
--max-tags-per-commit MAX_TAGS_PER_COMMIT
8383
Maximum number of tags to display for each commit (default: 1)
84+
--media-dir MEDIA_DIR
85+
The path to output the animation data and video file (default: .)
86+
--low-quality Render output video in low quality, useful for faster testing (default: False)
87+
--light-mode Enable light-mode with white background (default: False)
8488
```
8589

8690
## Command Examples
@@ -112,6 +116,27 @@ $ cd path/to/project/root
112116
$ git-story --show-outro --outro-top-text "My Git Repo" --outro-bottom-text "Thanks for watching!" --logo path/to/logo.png
113117
```
114118

119+
Customize the output video directory location:
120+
121+
```console
122+
$ cd path/to/project/root
123+
$ git-story --media-dir=path/to/output
124+
```
125+
126+
Use light mode for white background and black text, instead of the default black background with white text:
127+
128+
```console
129+
$ cd path/to/project/root
130+
$ git-story --light-mode
131+
```
132+
133+
Generate output video in low quality to speed up rendering time (useful for repeated testing):
134+
135+
```console
136+
$ cd path/to/project/root
137+
$ git-story --low-quality
138+
```
139+
115140
## Installation
116141
See **QuickStart** section for details on installing manim and GitPython dependencies. Then run:
117142

0 commit comments

Comments
 (0)