Skip to content

Commit a39ac3b

Browse files
committed
Merge remote-tracking branch 'origin/master' into newExamples
2 parents b054005 + f3aef5c commit a39ac3b

22 files changed

+460
-209
lines changed

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,26 @@ Manim is an animation engine for explanatory math videos. It's used to create pr
1010

1111
> NOTE: This repository is maintained by the Manim Community, and is not associated with Grant Sanderson or 3Blue1Brown in any way (though we are definitely indebted to him for providing his work to the world). If you want to study how Grant makes his videos, head over to his repository (3b1b/manim). This is a more frequently updated repository than that one, and is recommended if you want to use Manim for your own projects.
1212
13-
1413
## Table of Contents:
14+
1515
- [Installation](#installation)
1616
- [Usage](#usage)
1717
- [Documentation](#documentation)
1818
- [Help with Manim](#help-with-manim)
1919
- [Contributing](#contributing)
2020
- [License](#license)
2121

22-
2322
## Installation
2423

2524
Manim has a few dependencies that need to be installed before it. Please visit
2625
the
2726
[documentation](https://manimce.readthedocs.io/en/latest/installation.html)
2827
and follow the instructions according to your operating system.
2928

30-
3129
## Usage
3230

3331
Here is an example manim script:
32+
3433
```python
3534
from manim import *
3635

@@ -47,18 +46,18 @@ class SquareToCircle(Scene):
4746
self.play(FadeOut(square))
4847
```
4948

50-
Save this code in a file called `example.py`. Now open your terminal in the
49+
Save this code in a file called `example.py`. Now open your terminal in the
5150
folder where you saved the file and execute
51+
5252
```sh
5353
manim example.py SquareToCircle -pl
5454
```
5555

5656
You should see your video player pop up and play a simple scene where a square
57-
is transformed into a circle. You can find some more simple examples in the
57+
is transformed into a circle. You can find some more simple examples in the
5858
[GitHub repository](https://github.com/ManimCommunity/manim/tree/master/example_scenes).
5959
Visit the [official gallery](https://manimce.readthedocs.io/en/latest/examples.html) for more advanced examples.
6060

61-
6261
## Command line arguments
6362

6463
The general usage of manim is as follows:
@@ -68,33 +67,33 @@ The general usage of manim is as follows:
6867
The `-p` flag in the command above is for previewing, meaning the video file will automatically open when it is done rendering. The `-l` flag is for a faster rendering at a lower quality.
6968

7069
Some other useful flags include:
71-
* `-s` to skip to the end and just show the final frame.
72-
* `-n <number>` to skip ahead to the `n`'th animation of a scene.
73-
* `-f` show the file in the file browser.
70+
71+
- `-s` to skip to the end and just show the final frame.
72+
- `-n <number>` to skip ahead to the `n`'th animation of a scene.
73+
- `-f` show the file in the file browser.
7474

7575
For a thorough list of command line arguments, visit the
7676
[documentation](https://manimce.readthedocs.io/en/latest/tutorials/configuration.html).
7777

78-
7978
## Documentation
80-
Documentation is in progress at [ReadTheDocs](https://manimce.readthedocs.io/en/latest/).
8179

80+
Documentation is in progress at [ReadTheDocs](https://manimce.readthedocs.io/en/latest/).
8281

8382
## Help with Manim
83+
8484
If you need help installing or using Manim, please take a look at [the Reddit
8585
Community](https://www.reddit.com/r/manim) or the [Discord
86-
Community](https://discord.gg/mMRrZQW). For bug reports and feature requests,
86+
Community](https://discord.gg/mMRrZQW). For bug reports and feature requests,
8787
please open an issue.
8888

89-
9089
## Contributing
90+
9191
Is always welcome. In particular, there is a dire need for tests and
9292
documentation. For guidelines please see the
9393
[documentation](https://manimce.readthedocs.io/en/latest/contributing.html).
9494
This project uses [Poetry](https://python-poetry.org/docs/) for management. You need to have poetry installed and available in your environment.
9595
You can find more information about it in its [Documentation](https://manimce.readthedocs.io/en/latest/installation/for_dev.html)
9696

97-
9897
## License
9998

10099
The software is double-licensed under the MIT license, with copyright
Lines changed: 87 additions & 0 deletions
Loading

docs/source/_templates/logo-text.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<img src="{{ pathto('_static/manim-logo-sidebar.svg', 1) }}" alt="ManimCommunity logo" width="100%">
2+
<a href="{{ homepage() }}" class="text-logo">{{ theme_project_nav_name or shorttitle }}</a>

docs/source/changelog.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
Changelog
33
*********
44

5-
manimce-v1.0.0-dev
6-
==================
5+
v0.1.0
6+
======
77

8-
:Date: TBD
8+
:Date: October 21, 2020
99

1010
This is the first release of manimce after forking from 3b1b/manim. As such,
1111
developers have focused on cleaning up and refactoring the codebase while still

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939

4040
# -- Project information -----------------------------------------------------
4141

42-
project = "manim"
42+
project = "Manim"
4343
copyright = "2020, The Manim Community Dev Team"
4444
author = "The Manim Community Dev Team"
4545

docs/source/examples.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Examples
1+
Example Gallery
22
============
33

44
.. toctree::

logo/cropped.png

-135 KB
Loading

logo/dark/dark_background.png

87.6 KB
Loading

logo/dark/dark_background.svg

Lines changed: 85 additions & 0 deletions
Loading

logo/dark/transparent_background.png

82.4 KB
Loading

0 commit comments

Comments
 (0)