Skip to content

Commit ed64149

Browse files
Updated installation instructions (#1807)
* Update installation section * Indent * Update admonition * Update installation.rst Co-authored-by: Jason Villanueva <[email protected]>
1 parent 3cd2a27 commit ed64149

File tree

2 files changed

+11
-15
lines changed

2 files changed

+11
-15
lines changed

README.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,20 +34,15 @@ Manim is an animation engine for explanatory math videos. It's used to create pr
3434
- [License](#license)
3535

3636
## Installation
37-
37+
> **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.
38+
3839
Manim requires a few dependencies that must be installed prior to using it. If you
3940
want to try it out first before installing it locally, you can do so
4041
[in our online Jupyter environment](https://mybinder.org/v2/gist/behackl/725d956ec80969226b7bf9b4aef40b78/HEAD?filepath=basic%20example%20scenes.ipynb).
4142

42-
For the local installation, please visit the [Documentation](https://docs.manim.community/en/stable/installation.html)
43+
For local installation, please visit the [Documentation](https://docs.manim.community/en/stable/installation.html)
4344
and follow the appropriate instructions for your operating system.
44-
45-
Once the dependencies have been installed, run the following in a terminal window:
46-
47-
```bash
48-
pip install manim
49-
```
50-
45+
5146
## Usage
5247

5348
Manim is an extremely versatile package. The following is an example `Scene` you can construct:

docs/source/installation.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@ The following pages have instructions that are specific to your system. Once
66
you are done installing the dependencies, come back to this page to install
77
manim itself.
88

9-
.. note::
109

11-
Before installing manim, you should understand that there are a few main versions of manim
12-
today that are generally incompatible with each other.
13-
This documentation **only** covers the installation of the *community edition*;
14-
trying to use instructions intended for other versions of manim or vice versa will likely result in failure.
15-
In particular, most video tutorials are outdated. For more information, please read :doc:`Differences between Manim Versions <installation/versions>`.
10+
.. warning::
11+
These instructions are for the *community edition* of Manim **only**. Trying
12+
to use these instructions to install
13+
`3b1b/manim <https://github.com/3b1b/manim>`_ or instructions there to install
14+
this version will cause problems. Read the :doc:`Differences between Manim
15+
Versions <installation/versions>` and decide which version you wish to
16+
install, then only follow the instructions for your desired version.
1617

1718

1819
.. tip::

0 commit comments

Comments
 (0)