diff --git a/README.md b/README.md index 162beb492e..e1a7b36325 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,6 @@ 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 the main repository (3b1b/manim). This is a more frequently updated repository than the main one, and is recommended if you want to use Manim for your own projects. - - ## Table of Contents: - [Installation](#installation) * [Windows](#windows) @@ -36,13 +34,12 @@ Manim is an animation engine for explanatory math videos. It's used to create pr - [Documentation](#documentation) - [Help with Manim](#help-with-manim) - [Contributing](#contributing) -- [License](#license) ## Installation ### Windows -Before installing `manim-community`, there are some additional dependencies that you must have installed: +Before installing `manim-ce`, there are some additional dependencies that you must have installed: - Cairo - FFmpeg - Sox (optional, for sound) @@ -98,7 +95,7 @@ Before installing `manim-community`, there are some additional dependencies that ### Linux -Before installing `manim-community`, there are some additional dependencies that you must have installed: +Before installing `manim-ce`, there are some additional dependencies that you must have installed: - Cairo - FFmpeg - Sox (optional, for sound) @@ -132,7 +129,7 @@ sudo apt install ubuntu-restricted-extras ### Mac -Before installing `manim-community`, there are some additional dependencies that you must have installed: +Before installing `manim-ce`, there are some additional dependencies that you must have installed: - Homebrew - Cairo - FFmpeg @@ -181,7 +178,7 @@ If you have installed MacTeX and are comfortable with it, do not install BasicTe 4. Ensure that LaTeX works by running `latex` in the Terminal. -### Installing Manim-Community itself +### Installing Manim-CE itself Manim runs on Python 3.7+. If you'd like to just use the library, you can install it from PyPI via pip: @@ -190,7 +187,7 @@ pip3 install manimlib ``` However, if you'd like to contribute to and/or help develop -`manim-community`, you can clone this branch to your local device. To do +`manim-ce`, you can clone this branch to your local device. To do this, first make sure you have `git` installed. Then, clone this repo by executing either @@ -252,7 +249,7 @@ Documentation is in progress at [eulertour.com/docs](https://www.eulertour.com/d The issues board is reserved for bugs, and future features planned for 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) ## Contributing -Is always welcome. In particular, there is a dire need for tests and documentation. +Is always welcome. In particular, there is a dire need for tests and documentation. For instructions, guidelines and other details, please check out the file [CONTRIBUTING.md](https://github.com/ManimCommunity/manim/blob/master/CONTRIBUTING.md). diff --git a/setup.py b/setup.py index f47d495fb1..29ddf467e0 100755 --- a/setup.py +++ b/setup.py @@ -10,7 +10,7 @@ entry_points={ "console_scripts": [ "manim=manim.__main__:main", - "manimcm=manim.__main__:main", + "manimce=manim.__main__:main", ] }, install_requires=[