A community-maintained Python framework for creating mathematical animations.
Added documentation explaining the differences between manim versions (#1268)
Darylgolden45afef3ce4ca
diff --git a/docs/source/installation.rst b/docs/source/installation.rstindex c3b3174fd..5f0270f88 100644--- a/docs/source/installation.rst+++ b/docs/source/installation.rst@@ -6,6 +6,13 @@ The following pages have instructions that are specific to your system. Onceyou are done installing the dependencies, come back to this page to installmanim 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>`.+Installing dependencies***********************diff --git a/docs/source/installation/versions.rst b/docs/source/installation/versions.rstnew file mode 100644index 000000000..1357a8a20--- /dev/null+++ b/docs/source/installation/versions.rst@@ -0,0 +1,49 @@+Differences between Manim Versions+==================================++While originally a single library, there are now three main versions of manim,+each with their own advantages, disadvantages and ideal use cases.+It is important to understand these differences in order to select the best version+for your use case and avoid confusion arising from version mismatches.++A brief history of Manim+************************++Manim was originally created by Grant Sanderson as a personal project and+for use in his YouTube channel, `3Blue1Brown <https://www.youtube.com/channel/UCYO_jab_esuFRV4b17AJtAw>`_. As his channel gained popularity,+many grew to like the style of his animations and wanted to use manim for their own projects.+However, as manim was only intended for personal use,+it was very difficult for other users to install and use it.++In late 2019, Grant started working on faster OpenGL rendering in a new branch,+known as the shaders branch. In mid 2020, a group of developers forked it into what is now the community edition;+this is the version which is documented by this website.+In early 2021, Grant merged the shaders branch back into master, making it the default branch in his repository.+The old version is still available as the branch ``cairo-backend``.++The three versions of Manim+****************************++There are currently three main versions of manim. They are as follows:++- **ManimCE**: The community edition of manim. This is the version documented by this website, and is named `manim <https://pypi.org/project/manim/https://pypi.org/project/manim/>`_ on pip.+- `ManimGL <https://github.com/3b1b/manim>`_: The current version of manim that is used by 3blue1brown. It supports OpenGL rendering and interactivity, and is named ``manimgl`` on pip. You can find documentation for it `here <https://3b1b.github.io/manim/index.html>`_.+- `ManimCairo <https://github.com/3b1b/manim/tree/cairo-backend>`_: The old version of manim originally used by 3blue1brown. It is not available on pip.++Which version to use+********************+We recommend using the community edition for most purposes, as it has been developed to be more stable,+better tested, quicker to respond to community contributions, and easier for beginners to use.+It also has partial experimental OpenGL support, and should have full support shortly (as of April, 2021).++If you would like to use a version with full OpenGL support or render recent 3Blue1Brown videos (2020 onwards), you should use ManimGL.++If you would like to render old 3Blue1Brown projects (2019 and before), you should use ManimCairo.++Notes on installation, documentation and use+********************************************+If you are a beginner, it is very important that you only use the documentation for your desired version.+Trying to install or learn manim using documentation or guides made for different versions will likely fail and only lead to more confusion.+As many tutorials and guides on the internet are outdated, we do not recommend you follow them.+You should only read tutorials and documentation for other versions once you are aware of the differences between them+and know how to adapt code for your desired version.