-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Clean up README #586
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Clean up README #586
Changes from all commits
e72390d
2099054
be71851
5988cec
0a6e7e1
e63c957
11e21a9
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,45 @@ | ||
|  | ||
|
|
||
|  | ||
| [](https://manimce.readthedocs.io/en/latest/?badge=latest) | ||
| [](http://choosealicense.com/licenses/mit/) | ||
| [](https://www.reddit.com/r/manim/) | ||
| [](https://discord.gg/mMRrZQW) | ||
|
|
||
| Manim is an animation engine for explanatory math videos. It's used to create precise animations programmatically, as seen in the videos at [3Blue1Brown](https://www.3blue1brown.com/). | ||
|
|
||
| > 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. | ||
| <p align="center"> | ||
| <img src="https://raw.githubusercontent.com/ManimCommunity/manim/master/logo/cropped.png" /> | ||
| <br /> | ||
| <br /> | ||
| <img src="https://img.shields.io/badge/license-MIT-red.svg?style=flat" alt="MIT License" src="http://choosealicense.com/licenses/mit/" /> | ||
| <img src="https://img.shields.io/reddit/subreddit-subscribers/manim.svg?color=orange&label=reddit" alt="Reddit" href="https://www.reddit.com/r/manim/" /> | ||
| <img src="https://img.shields.io/discord/581738731934056449.svg?label=discord&color=yellow" alt="Discord" href="https://discord.gg/mMRrZQW" /> | ||
| <img src="https://readthedocs.org/projects/manimce/badge/?version=latest" alt="Documentation Status" href="https://manimce.readthedocs.io/en/latest/?badge=latest" /> | ||
| <img src="https://github.com/ManimCommunity/manim/workflows/CI/badge.svg" alt="CI" /> | ||
|
Comment on lines
+5
to
+9
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd consider the fact that the CI is is passing and the docs are building to be more immediately useful to visitors than the license and social links, so I prefer the old order. Additionally, it's odd for the reddit link to be orange rather than red and for the discord link to be yellow rather than green (which is a standard "working" color) or blue (which is part of discords branding). The change of the MIT button is a little better, but I don't really see any reason to change it from the standard blue used on shields.io. |
||
| <br /> | ||
| <br /> | ||
| <i>An animation engine for explanatory math videos</i> | ||
| </p> | ||
|
|
||
| <hr /> | ||
|
|
||
| `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/). | ||
|
|
||
| > 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 that his, and it's recommended to use this fork if you'd like to use Manim for your own projects. | ||
|
|
||
| ## Table of Contents: | ||
|
|
||
| - [Installation](#installation) | ||
| - [Usage](#usage) | ||
| - [Documentation](#documentation) | ||
| - [Help with Manim](#help-with-manim) | ||
| - [Contributing](#contributing) | ||
| - [License](#license) | ||
| - [Installation](#installation) | ||
| - [Usage](#usage) | ||
| - [Documentation](#documentation) | ||
| - [Help with Manim](#help-with-manim) | ||
| - [Contributing](#contributing) | ||
| - [License](#license) | ||
|
|
||
| ## Installation | ||
|
|
||
| Manim has a few dependencies that need to be installed before it. Please visit | ||
| the | ||
| [documentation](https://manimce.readthedocs.io/en/latest/installation.html) | ||
| and follow the instructions according to your operating system. | ||
| 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. | ||
|
|
||
| Once the dependencies have been installed, run the following in a terminal window: | ||
leotrs marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ```bash | ||
| pip install manimce | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| Here is an example manim script: | ||
| Manim is an extremely versatile package. The following is an example `Scene` you can construct: | ||
|
|
||
| ```python | ||
| from manim import * | ||
|
|
@@ -46,56 +57,46 @@ class SquareToCircle(Scene): | |
| self.play(FadeOut(square)) | ||
| ``` | ||
|
|
||
| Save this code in a file called `example.py`. Now open your terminal in the | ||
| folder where you saved the file and execute | ||
| In order to view the output of this scene, save the code in a file called `example.py`. Then, run the following in a terminal window: | ||
|
|
||
| ```sh | ||
| manim example.py SquareToCircle -pl | ||
| manim example.py SquareToCircle -p -ql | ||
| ``` | ||
|
|
||
| You should see your video player pop up and play a simple scene where a square | ||
| is transformed into a circle. You can find some more simple examples in the | ||
| [GitHub repository](https://github.com/ManimCommunity/manim/tree/master/example_scenes). | ||
| Visit the [official gallery](https://manimce.readthedocs.io/en/latest/examples.html) for more advanced examples. | ||
| 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 | ||
| [GitHub repository](master/example_scenes). You can also visit the [official gallery](https://manimce.readthedocs.io/en/latest/examples.html) for more advanced examples. | ||
|
|
||
| ## Command line arguments | ||
|
|
||
| The general usage of manim is as follows: | ||
|
|
||
|  | ||
|  | ||
|
|
||
| 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. | ||
| The `-p` flag in the command above is for previewing, meaning the video file will automatically open when it is done rendering. The `-ql` flag is for a faster rendering at a lower quality. | ||
|
|
||
| Some other useful flags include: | ||
|
|
||
| - `-s` to skip to the end and just show the final frame. | ||
| - `-n <number>` to skip ahead to the `n`'th animation of a scene. | ||
| - `-f` show the file in the file browser. | ||
| - `-s` to skip to the end and just show the final frame. | ||
| - `-n <number>` to skip ahead to the `n`'th animation of a scene. | ||
| - `-f` show the file in the file browser. | ||
|
|
||
| For a thorough list of command line arguments, visit the | ||
| [documentation](https://manimce.readthedocs.io/en/latest/tutorials/configuration.html). | ||
| For a thorough list of command line arguments, visit the [documentation](https://manimce.readthedocs.io/en/latest/tutorials/configuration.html). | ||
|
|
||
| ## Documentation | ||
|
|
||
| Documentation is in progress at [ReadTheDocs](https://manimce.readthedocs.io/en/latest/). | ||
|
|
||
| ## Help with Manim | ||
|
|
||
| If you need help installing or using Manim, please take a look at [the Reddit | ||
| Community](https://www.reddit.com/r/manim) or the [Discord | ||
| Community](https://discord.gg/mMRrZQW). For bug reports and feature requests, | ||
| please open an issue. | ||
| If you need help installing or using Manim, feel free to reach out to our [Discord | ||
| Server](https://discord.gg/mMRrZQW) or [Reddit Community](https://www.reddit.com/r/manim). If you would like to submit bug report or feature request, please open an issue. | ||
|
|
||
| ## Contributing | ||
|
|
||
| Is always welcome. In particular, there is a dire need for tests and | ||
| documentation. For guidelines please see the | ||
| [documentation](https://manimce.readthedocs.io/en/latest/contributing.html). | ||
| This project uses [Poetry](https://python-poetry.org/docs/) for management. You need to have poetry installed and available in your environment. | ||
| You can find more information about it in its [Documentation](https://manimce.readthedocs.io/en/latest/installation/for_dev.html) | ||
| 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). | ||
|
|
||
| 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). | ||
|
|
||
| ## License | ||
|
|
||
| The software is double-licensed under the MIT license, with copyright | ||
| by 3blue1brown LLC (see LICENSE), and copyright by Manim Community | ||
| Developers (see LICENSE.community). | ||
| The software is double-licensed under the MIT license, with copyright by 3blue1brown LLC (see LICENSE), and copyright by Manim Community Developers (see LICENSE.community). | ||
Uh oh!
There was an error while loading. Please reload this page.