A community-maintained Python framework for creating mathematical animations.
Added a "How to Cite Manim" section to the Readme (#1425)
Mark Miller1f0c4a4c8ade
diff --git a/README.md b/README.mdindex 6e44ecf30..074d41d6e 100644--- a/README.md+++ b/README.md@@ -72,7 +72,7 @@ class SquareToCircle(Scene):In order to view the output of this scene, save the code in a file called `example.py`. Then, run the following in a terminal window:```sh-manim -p -ql example.py SquareToCircle+manim -p -ql example.py SquareToCircle```You should see your native video player program pop up and play a simple scene in which a square is transformed into a circle. You may find some more simple examples within this@@ -157,6 +157,31 @@ Contributions to Manim are always welcome. In particular, there is a dire need fMost developers on the project use [Poetry](https://python-poetry.org/docs/) for management. You'll want to have poetry installed and available in your environment. You can learn more about `poetry` and how to use it at its [documentation](https://docs.manim.community/en/stable/installation/for_dev.html).+## How to Cite Manim++We acknowledge the importance of good software to support research, and we note+that research becomes more valuable when it is communicated effectively. To+demonstrate the value of Manim, we ask that you cite Manim in your work.+Currently, the best way to cite Manim is to reference the+[Manim home page](https://www.manim.community) using this BibTeX entry (the+entry is for release `v0.6.0`, but can be adapted easily):++```+@Manual{Manim:v0.6.0,+ key = {Manim},+ author = {{The Manim Community Developers}},+ title = {{Manim} -- {M}athematical {A}nimation {F}ramework ({V}ersion v0.6.0)},+ note = {\url{https://www.manim.community}},+ year = 2021,+}+```++This should render a reference that looks more or less like this:++42. The Manim Community Developers,+ [Manim – Mathematical Animation Framework (Version v0.6.0)](https://www.manim.community).+ 2021.+## Code of ConductOur full code of conduct, and how we enforce it, can be read on [our website](https://docs.manim.community/en/stable/conduct.html).diff --git a/docs/source/index.rst b/docs/source/index.rstindex 5ab5eff8f..1243ec400 100644--- a/docs/source/index.rst+++ b/docs/source/index.rst@@ -15,11 +15,22 @@ This project is still very much a work in progress, but we hope that theinformation here will make it easier for newcomers to get started using``Manim``.-.. tip::+.. tip::All content of the docs is licensed under the MIT license. Especially for the examplesyou encounter: Feel free to use this code in your own projects!+ We are curious to see the awesome projects you build using this library, feel+ free to share your projects with us `on Twitter <https://twitter.com/manim_community>`_,+ `Reddit <https://www.reddit.com/r/manim/>`_, or via `Discord <https://discord.gg/mMRrZQW>`_.++ In case you publish your work made with Manim, we would appreciate if you+ add a link to `our homepage <https://www.manim.community>`_ or+ `our GitHub repository <https://github.com/ManimCommunity/manim>`_. If you+ use Manim in a scientific context, instructions on how to cite a particular+ release can be found+ `in our README <https://github.com/ManimCommunity/manim/blob/master/README.md>`_.+.. note::As a quick reference, here are some often used modules, classes and methods:@@ -53,12 +64,3 @@ information here will make it easier for newcomers to get started usingreporting_bugscontributingconduct----Navigation-==================--* :ref:`genindex`-* :ref:`modindex`-* :ref:`search`