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: .github/workflows/python-publish.yml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -47,5 +47,5 @@ jobs:
47
47
with:
48
48
upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
<i>An animation engine for explanatory math videos</i>
14
18
</p>
15
-
16
19
<hr />
17
20
18
-
`manim` is an animation engine for explanatory math videos. It's used to create precise animations programmatically, as demonstrated in the videos of [3Blue1Brown](https://www.3blue1brown.com/).
21
+
22
+
Manim is an animation engine for explanatory math videos. It's used to create precise animations programmatically, as demonstrated in the videos of [3Blue1Brown](https://www.3blue1brown.com/).
19
23
20
24
> NOTE: This repository is maintained by the Manim Community, and is not associated with Grant Sanderson or 3Blue1Brown in any way (although we are definitely indebted to him for providing his work to the world). If you would like to study how Grant makes his videos, head over to his repository ([3b1b/manim](https://github.com/3b1b/manim)). This fork is updated more frequently than his, and it's recommended to use this fork if you'd like to use Manim for your own projects.
21
25
@@ -30,12 +34,12 @@
30
34
31
35
## Installation
32
36
33
-
Manim requires a few dependencies that must be installed prior to using it. Please visit the [documentation](https://manimce.readthedocs.io/en/latest/installation.html) and follow the appropriate instructions for your operating system.
37
+
Manim requires a few dependencies that must be installed prior to using it. Please visit the [Documentation](https://docs.manim.community/en/latest/installation.html) and follow the appropriate instructions for your operating system.
34
38
35
39
Once the dependencies have been installed, run the following in a terminal window:
You should see your native video player program pop up and play a simple scene in which a square is transformed into a circle. You may find some more simple examples within this
68
-
[GitHub repository](master/example_scenes). You can also visit the [official gallery](https://manimce.readthedocs.io/en/latest/examples.html) for more advanced examples.
72
+
[GitHub repository](master/example_scenes). You can also visit the [official gallery](https://docs.manim.community/en/latest/examples.html) for more advanced examples.
@@ -81,11 +85,11 @@ Some other useful flags include:
81
85
-`-n <number>` to skip ahead to the `n`'th animation of a scene.
82
86
-`-f` show the file in the file browser.
83
87
84
-
For a thorough list of command line arguments, visit the [documentation](https://manimce.readthedocs.io/en/latest/tutorials/configuration.html).
88
+
For a thorough list of command line arguments, visit the [documentation](https://docs.manim.community/en/latest/tutorials/configuration.html).
85
89
86
90
## Documentation
87
91
88
-
Documentation is in progress at [ReadTheDocs](https://manimce.readthedocs.io/en/latest/).
92
+
Documentation is in progress at [ReadTheDocs](https://docs.manim.community/).
89
93
90
94
## Help with Manim
91
95
@@ -94,9 +98,9 @@ Server](https://discord.gg/mMRrZQW) or [Reddit Community](https://www.reddit.com
94
98
95
99
## Contributing
96
100
97
-
Contributions to `manim` are always welcome. In particular, there is a dire need for tests and documentation. For contribution guidelines, please see the [documentation](https://manimce.readthedocs.io/en/latest/contributing.html).
101
+
Contributions to Manim are always welcome. In particular, there is a dire need for tests and documentation. For contribution guidelines, please see the [documentation](https://docs.manim.community/en/latest/contributing.html).
98
102
99
-
This project uses[Poetry](https://python-poetry.org/docs/) for management. You must have poetry installed and available in your environment. You can learn more `poetry` and how to use it at its [Documentation](https://manimce.readthedocs.io/en/latest/installation/for_dev.html).
103
+
Most developers on the project use[Poetry](https://python-poetry.org/docs/) for management. You'll want to have poetry installed and available in your environment. You can learn more `poetry` and how to use it at its [documentation](https://docs.manim.community/en/latest/installation/for_dev.html).
Manim is a Python library for creating mathematical animations [originally created](https://github.com/3b1b/manim) by Grant "3Blue1Brown" Sanderson. The images in this repository correspond to the [community-maintained version of Manim](https://github.com/ManimCommunity/manim).
14
+
15
+
To get an impression what Manim can be used for, have a look at our [Example Gallery](https://docs.manim.community/en/stable/examples.html).
16
+
17
+
# How to use this image
18
+
## Quick Example
19
+
To render a scene `CircleToSquare` in a file `test_scenes.py` contained in your current working directory while preserving your user and group ID, use
Instead of using the "throwaway container" approach sketched above, you can also create a named container that you can also modify to your liking. First, run
26
+
```
27
+
$ docker run -it --name my-manim-container -v "$(pwd):/manim" manimcommunity/manim /bin/bash
28
+
```
29
+
to obtain an interactive shell inside your container allowing you to, e.g., install further dependencies (like texlive packages using `tlmgr`). Exit the container as soon as you are satisfied. Then, before using it, start the container by running
30
+
```
31
+
$ docker start my-manim-container
32
+
```
33
+
Then, to render a scene `CircleToSquare` in a file `test_scenes.py`, call
When executing `manim` within a Docker container, several command line flags (in particular `-p` (preview file) and `-f` (show output file in the file browser)) are not supported.
40
+
41
+
# Building the image
42
+
The docker image corresponding to the checked out version of the git repository
#. The global ``config`` dict has been replaced by a global ``config`` instance
25
51
of the new class :class:`~.ManimConfig`. This class has a dict-like API, so
26
52
this should not break user code, only make it more robust. See the
27
53
Configuration tutorial for details.
54
+
#. Added the option to configure a directory for external assets (via :pr:`649`).
28
55
29
56
30
57
Documentation
31
58
=============
32
59
33
60
#. Add ``:issue:`` and ``:pr:`` directives for simplifying linking to issues and
34
61
pull requests on GitHub (via :pr:`685`).
62
+
#. Add a ``skip-manim`` tag for skipping the ``.. manim::`` directive when
63
+
building the documentation locally (via :pr:`796`).
35
64
36
65
37
66
Mobjects, Scenes, and Animations
38
67
================================
39
68
40
69
#. The ``alignment`` attribute to Tex and MathTex has been removed in favour of ``tex_environment``.
41
70
#. :class:`~.Text` now uses Pango for rendering. ``PangoText`` has been removed. The old implementation is still available as a fallback as :class:`~.CairoText`.
42
-
#. **New**: Variations of :class:`~.Dot` have been added as :class:`~.AnnotationDot`
71
+
#. Variations of :class:`~.Dot` have been added as :class:`~.AnnotationDot`
43
72
(a bigger dot with bolder stroke) and :class:`~.LabeledDot` (a dot containing a
44
73
label).
45
74
#. Scene.set_variables_as_attrs has been removed (via :pr:`692`).
@@ -50,6 +79,11 @@ Mobjects, Scenes, and Animations
50
79
#. Added BraceBetweenPoints (via :pr:`693`).
51
80
#. Added ArcPolygon and ArcPolygonFromArcs (via :pr:`707`).
52
81
#. Added Cutout (via :pr:`760`).
82
+
#. Added Mobject raise not implemented errors for dunder methods and implementations for VGroup dunder methods (via :pr:`790`).
83
+
#. Added :class:`~.ManimBanner` for a animated version of our logo and banner (via :pr:`729`)
84
+
#. The background color of a scene can now be changed reliably by setting, e.g.,
#. Move all imports to :code:`__init__`, so :code:`from manim import *` replaces :code:`from manimlib.imports import *`
172
-
#. Global dir variable handling has been removed. Instead :code:`initialize_directories`, if needed, overrides the values from the cfg files at runtime.
206
+
#. Global dir variable handling has been removed. Instead :code:`initialize_directories`, if needed, overrides the values from the cfg files at runtime.
0 commit comments