search

ManimCommunity / manim

A community-maintained Python framework for creating mathematical animations.
https://www.manim.community
MIT License
19.95k stars 1.48k forks source link

Add some output example to README #1455

Closed kilacoda-old closed 7 months ago

kilacoda-old commented 3 years ago

Enhancement proposal

Currently our README only talks about manim, but doesn't show what it's capable to do. Adding a few example videos/gifs might make using the library more attractive to newcomers.

Additional comments

An argument may be made that "oh well, all the 3b1b videos are examples aren't they?" and while I agree, it's better to have something on the front page of the repo, instead of sending someone off to youtube.

behackl commented 3 years ago

I agree (although we'll have to think about how exactly we do that -- maybe we can link to videos generated in the documentation?)!

On a related note, I would also like to improve our landing page https://www.manim.community in a similar way, eventually. I like how https://reanimate.github.io have a simple but nonetheless impressive showcase featured.

Nikhil0504 commented 3 years ago

I like the Reanimate website too, maybe we could use the same methodology and make some kind of a showcase that shows the most viewed examples with some short descriptions.

But I think we will have to keep the video files rendered before hand and keep them in a folder somewhere. Correct me if I am wrong about this though.

behackl commented 7 months ago

The website has been improved, and I think it is not a bad idea to keep the readme somewhat simple. Closing.