Skip to content

Commit de7d4ed

Browse files
authored
Update README.md
1 parent c362192 commit de7d4ed

File tree

1 file changed

+25
-7
lines changed

1 file changed

+25
-7
lines changed

README.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,23 +38,41 @@ template. Once you are logged in, click on:
3838
</picture>
3939
</p>
4040

41-
42-
### Your presentation
41+
### Customizing your presentation
4342

4443
By default, the generated presentation is obtained from the
4544
[`slides.py`](./slides.py) file, uses Manim Community Edition,
4645
and renders the following scenes: `Introduction`, `WithTeX`,
4746
ans `Outro`.
4847

49-
### Customizing
48+
Of course, you can update or create Python files to
49+
generate your animations. If you require a specific
50+
version of `manim-slides`, `manim` or `manimlib`,
51+
please edit [`requirements.txt`](./requirements.txt).
52+
53+
Additionally, you can edit the following environ variables
54+
to reflect your changes:
5055

5156
https://github.com/jeertmans/manim-slides-starter/blob/bd59f1e3da1eb12e2587898aaedf51c7f779501a/.github/workflows/deploy_pages.yml#L19-L22
5257

53-
## Where is the output?
58+
> **WARNING**: `manimgl` is currently not supported, as rendering animations
59+
> inside GitHub workflows seems complex...
5460
55-
If everything goes well,
61+
## Where is the output?
5662

5763
On every commit to the `main` branch, a new deployment action should be
58-
triggered. If that is not the case, inspect the [actions](./actions) tab for
64+
triggered. If that is not the case, inspect the [actions](../../actions) tab for
5965
any error message. You can also manually trigger a deployment by clicking on
60-
the [*Run workflow*](./actions/workflows/deploy_pages.yml) button.
66+
the [*Run workflow*](../../actions/workflows/deploy_pages.yml) button.
67+
68+
If everything goes well, the deploying site should be on your
69+
personal GitHub pages site: `https://<username>.github.io/<repository_name>`.
70+
71+
For example, this starter's website is:
72+
https://jeertmans.github.io/manim-slides-starter.
73+
74+
> NOTE: the first time the deployment action is used,
75+
> the `gh-pages` branch is created. You might need
76+
> to go to [`Settings -> Pages`](../../settings/pages)
77+
> and make sure that the *Source* is
78+
> *Deploy from a branch*, and *branch* is *gh-pages*.

0 commit comments

Comments
 (0)