mirror of
https://github.com/jeertmans/manim-slides.git
synced 2025-09-17 11:12:39 +08:00
16f740d2ad
* chore(deps): make Qt backend optional TODO: - [ ] Add relevant entry in CHANGELOG - [ ] Update install documentation - [ ] Make sure `manim-slides convert` can run without any Qt backend - [ ] Make sure test suite works (partially) without any Qt backend - [ ] Make sure we can import `manim_slides` without any Qt backend * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * chore(deps): some fixes but wip * chore(docs): update * chore(deps): support PyQt6 * chore(deps): make Qt backend optional TODO: - [ ] Add relevant entry in CHANGELOG - [ ] Update install documentation - [ ] Make sure `manim-slides convert` can run without any Qt backend - [ ] Make sure test suite works (partially) without any Qt backend - [ ] Make sure we can import `manim_slides` without any Qt backend * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * chore(deps): some fixes but wip * chore(docs): update * chore(deps): support PyQt6 * fix(deps): ci and docs * fix(lib): missing package * chore(ci): does it work? * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * chore(test): skip failing * chore(docs): update * chore(docs): update * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix(docs): typo * fix(test): quit instead of shutdown --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
35 lines
827 B
Markdown
35 lines
827 B
Markdown
# Quickstart
|
|
|
|
If not already, install Manim Slides, along with either Manim or ManimGL,
|
|
see [installation](./installation).
|
|
|
|
## Creating your first slides
|
|
|
|
```{include} ../../README.md
|
|
:start-after: <!-- start usage -->
|
|
:end-before: <!-- end usage -->
|
|
```
|
|
|
|
:::{note}
|
|
Using `manim-slides render` makes sure to use the `manim`
|
|
(or `manimlib`) library that was installed in the same Python environment.
|
|
Put simply, this is a wrapper around
|
|
`manim render [ARGS]...` (or `manimgl [ARGS]...`).
|
|
:::
|
|
|
|
|
|
```{include} ../../README.md
|
|
:start-after: <!-- start more-usage -->
|
|
:end-before: <!-- end more-usage -->
|
|
```
|
|
|
|
The output slides should look this this:
|
|
|
|
```{eval-rst}
|
|
.. manim-slides:: ../../example.py:BasicExample
|
|
:hide_source:
|
|
:quality: high
|
|
```
|
|
|
|
For more advanced examples, see the [Examples](reference/examples) section.
|