Skip to content

Commit beaf44d

Browse files
authored
docs: clarify Manim project choice (#2475)
1 parent 4b7a720 commit beaf44d

2 files changed

Lines changed: 22 additions & 2 deletions

File tree

docs/source/development/contributing.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,20 @@ Contributing
33

44
Accept any contribution you make :)
55

6+
Choose the right Manim project first
7+
------------------------------------
8+
9+
This repository is the ManimGL version used by 3Blue1Brown. It focuses on
10+
OpenGL rendering, interactive workflows, and the needs of the videos in
11+
`3b1b/videos <https://github.com/3b1b/videos>`_. Pull requests are welcome here,
12+
but reviews can take some time.
13+
14+
For broad community features, packaging changes, or beginner-oriented
15+
documentation, also consider
16+
`ManimCommunity/manim <https://github.com/ManimCommunity/manim>`_, which has a
17+
larger contributor workflow and more active community review. If your change is
18+
specific to ManimGL, keep it in this repository.
19+
620
- **Contribute to the manim source code**:
721

822
Please fork to your own repository and make changes, submit a pull request, and fill in
@@ -56,4 +70,4 @@ How to build this documentation
5670
cd docs/
5771
make html
5872
59-
- The output document is located in ``docs/build/html/``
73+
- The output document is located in ``docs/build/html/``

docs/source/getting_started/quickstart.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
Quick Start
22
===========
33

4+
This quick start is for ManimGL, the OpenGL-based version maintained in
5+
`3b1b/manim <https://github.com/3b1b/manim>`_. If you are looking for the
6+
Community Edition, install and follow the docs from
7+
`ManimCommunity/manim <https://github.com/ManimCommunity/manim>`_ instead.
8+
The two projects use different package names and setup instructions, so choose
9+
the version you want before installing dependencies or copying examples.
10+
411
After installing the manim environment according to the instructions on the
512
:doc:`installation` page, you can try to make a scene yourself from scratch.
613

@@ -253,4 +260,3 @@ You succeeded!
253260
After reading the above content, you already know how to use manim.
254261
Below you can see some examples, in the :doc:`example_scenes` page.
255262
But before that, you'd better have a look at the :doc:`configuration` of manim.
256-

0 commit comments

Comments
 (0)