You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+29-4Lines changed: 29 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,7 @@ $ cd path/to/project/root
52
52
$ git-story
53
53
```
54
54
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`.
56
56
57
57
6) Use command-line options for customization, see usage:
58
58
@@ -70,17 +70,21 @@ optional arguments:
70
70
--hide-merged-chains Hide commits from merged branches, i.e. only display mainline commits (default: False)
71
71
--reverse Display commits in reverse order in the Git animation (default: False)
72
72
--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)
74
74
--outro-top-text OUTRO_TOP_TEXT
75
75
Custom text to display above the logo during the outro (default: Thanks for using Initial Commit!)
76
76
--outro-bottom-text OUTRO_BOTTOM_TEXT
77
77
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)
80
80
--max-branches-per-commit MAX_BRANCHES_PER_COMMIT
81
81
Maximum number of branch labels to display for each commit (default: 2)
82
82
--max-tags-per-commit MAX_TAGS_PER_COMMIT
83
83
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)
84
88
```
85
89
86
90
## Command Examples
@@ -112,6 +116,27 @@ $ cd path/to/project/root
112
116
$ git-story --show-outro --outro-top-text "My Git Repo" --outro-bottom-text "Thanks for watching!" --logo path/to/logo.png
113
117
```
114
118
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
+
115
140
## Installation
116
141
See **QuickStart** section for details on installing manim and GitPython dependencies. Then run:
0 commit comments