Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

Updated installation instructions (#1807)

Darylgoldened64149aa3ec
diff --git a/README.md b/README.md
index f45908d4c..170c60b71 100644
--- a/README.md
+++ b/README.md
@@ -34,20 +34,15 @@ Manim is an animation engine for explanatory math videos. It's used to create pr
- [License](#license)
## Installation
-
+> **WARNING:** These instructions are for the community version _only_. Trying to use these instructions to install [3b1b/manim](https://github.com/3b1b/manim) or instructions there to install this version will cause problems. Read [this](https://docs.manim.community/en/stable/installation/versions.html) and decide which version you wish to install, then only follow the instructions for your desired version.
+
Manim requires a few dependencies that must be installed prior to using it. If you
want to try it out first before installing it locally, you can do so
[in our online Jupyter environment](https://mybinder.org/v2/gist/behackl/725d956ec80969226b7bf9b4aef40b78/HEAD?filepath=basic%20example%20scenes.ipynb).
-For the local installation, please visit the [Documentation](https://docs.manim.community/en/stable/installation.html)
+For local installation, please visit the [Documentation](https://docs.manim.community/en/stable/installation.html)
and follow the appropriate instructions for your operating system.
-
-Once the dependencies have been installed, run the following in a terminal window:
-
-```bash
-pip install manim
-```
-
+
## Usage
Manim is an extremely versatile package. The following is an example `Scene` you can construct:
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
index eb0dec6ac..d4b7743a2 100644
--- a/docs/source/installation.rst
+++ b/docs/source/installation.rst
@@ -6,13 +6,14 @@ The following pages have instructions that are specific to your system. Once
you are done installing the dependencies, come back to this page to install
manim itself.
-.. note::
- Before installing manim, you should understand that there are a few main versions of manim
- today that are generally incompatible with each other.
- This documentation **only** covers the installation of the *community edition*;
- trying to use instructions intended for other versions of manim or vice versa will likely result in failure.
- In particular, most video tutorials are outdated. For more information, please read :doc:`Differences between Manim Versions <installation/versions>`.
+.. warning::
+ These instructions are for the *community edition* of Manim **only**. Trying
+ to use these instructions to install
+ `3b1b/manim <https://github.com/3b1b/manim>`_ or instructions there to install
+ this version will cause problems. Read the :doc:`Differences between Manim
+ Versions <installation/versions>` and decide which version you wish to
+ install, then only follow the instructions for your desired version.
.. tip::