File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -3,6 +3,20 @@ Contributing
33
44Accept 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
822Please 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/ ``
Original file line number Diff line number Diff line change 11Quick 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+
411After 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!
253260After reading the above content, you already know how to use manim.
254261Below you can see some examples, in the :doc: `example_scenes ` page.
255262But before that, you'd better have a look at the :doc: `configuration ` of manim.
256-
You can’t perform that action at this time.
0 commit comments