diff --git a/README.md b/README.md index c91b2a413c..4ea2333474 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![logo](https://raw.githubusercontent.com/ManimCommunity/manim/master/logo/logoWAlpha.svg) +![logo](https://raw.githubusercontent.com/ManimCommunity/manim/master/logo/light/transparent_background.svg) ![CI](https://github.com/ManimCommunity/manim/workflows/CI/badge.svg) [![Documentation Status](https://readthedocs.org/projects/manimce/badge/?version=latest)](https://manimce.readthedocs.io/en/latest/?badge=latest) @@ -10,8 +10,8 @@ Manim is an animation engine for explanatory math videos. It's used to create pr > 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. - ## Table of Contents: + - [Installation](#installation) - [Usage](#usage) - [Documentation](#documentation) @@ -19,7 +19,6 @@ Manim is an animation engine for explanatory math videos. It's used to create pr - [Contributing](#contributing) - [License](#license) - ## Installation Manim has a few dependencies that need to be installed before it. Please visit @@ -27,10 +26,10 @@ the [documentation](https://manimce.readthedocs.io/en/latest/installation.html) and follow the instructions according to your operating system. - ## Usage Here is an example manim script: + ```python from manim import * @@ -47,18 +46,18 @@ class SquareToCircle(Scene): self.play(FadeOut(square)) ``` -Save this code in a file called `example.py`. Now open your terminal in the +Save this code in a file called `example.py`. Now open your terminal in the folder where you saved the file and execute + ```sh manim example.py SquareToCircle -pl ``` 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 +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. - ## Command line arguments The general usage of manim is as follows: @@ -68,33 +67,33 @@ 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. Some other useful flags include: -* `-s` to skip to the end and just show the final frame. -* `-n ` 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 ` 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). - ## Documentation -Documentation is in progress at [ReadTheDocs](https://manimce.readthedocs.io/en/latest/). +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, +Community](https://discord.gg/mMRrZQW). For bug reports and feature requests, 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) - ## License The software is double-licensed under the MIT license, with copyright diff --git a/logo/logoB.png b/logo/dark/dark_background.png similarity index 100% rename from logo/logoB.png rename to logo/dark/dark_background.png diff --git a/logo/logoB.svg b/logo/dark/dark_background.svg similarity index 100% rename from logo/logoB.svg rename to logo/dark/dark_background.svg diff --git a/logo/logoBAlpha.png b/logo/dark/transparent_background.png similarity index 100% rename from logo/logoBAlpha.png rename to logo/dark/transparent_background.png diff --git a/logo/logoBAlpha.svg b/logo/dark/transparent_background.svg similarity index 100% rename from logo/logoBAlpha.svg rename to logo/dark/transparent_background.svg diff --git a/logo/logoW.png b/logo/light/light_background.png similarity index 100% rename from logo/logoW.png rename to logo/light/light_background.png diff --git a/logo/logoW.svg b/logo/light/light_background.svg similarity index 100% rename from logo/logoW.svg rename to logo/light/light_background.svg diff --git a/logo/logoWAlpha.png b/logo/light/transparent_background.png similarity index 100% rename from logo/logoWAlpha.png rename to logo/light/transparent_background.png diff --git a/logo/logoWAlpha.svg b/logo/light/transparent_background.svg similarity index 100% rename from logo/logoWAlpha.svg rename to logo/light/transparent_background.svg diff --git a/logo/logoB&W.png b/logo/light_and_dark.png similarity index 100% rename from logo/logoB&W.png rename to logo/light_and_dark.png diff --git a/logo/logoB&W.svg b/logo/light_and_dark.svg similarity index 100% rename from logo/logoB&W.svg rename to logo/light_and_dark.svg