From 61d9a2f6a1ea9911b51da8340d75f2019fb0570d Mon Sep 17 00:00:00 2001 From: Grant Sanderson Date: Tue, 6 Sep 2016 11:06:31 -0700 Subject: [PATCH] A more honest README --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5c3eb07f..a4434cc2 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,14 @@ # animations Animation engine for explanatory math videos -For those who want to play around with this tool, I should -be upfront that I've mostly had my own use cases (i.e. 3b1b videos) -in mind while building it, and it might not be the most friendly thing -to get up and running. In particular, I have not done a great job -tracking requirements, and documentation is..well..sparse. +For those who want to play around with this tool, I should be upfront that I've mostly had my own use cases (i.e. 3b1b videos) in mind while building it, and it might not be the most friendly thing to get up and running. In particular, I have not done a great job tracking requirements, and documentation, to put it euphamistically, almost exclusively takes the form of naming conventions. + +For 9/10 math animation needs, you'd probably be better off using a more well-maintained tool, like mathplotlib or mathematica. I happen to think the program "Grapher" built into osx is really great, and surprisingly versatile for many needs. My own reasons for building this tool and using it for videos are twofold, and I'm not sure how well they apply to other people's use cases. + + 1) If I wish to work with some new type of mathematical thing (e.g. a fractal), or to experiment with a different type of animation, it's easier to work it into the underlying system and manipulate it the same way as more standard objects/animation. Admittedly, though, part of the reason I find this easier is because I'm more familiar with the underlying system here than I am with others. This keeps me from shying away from certain video topics that I would otherwise have no idea how to animate. + + 2) Having my own tool has been a forcing function for having a style which is more original than what I may have otherwise produced. The cost of this was slower video production when the tool was in its early days, and during points when I do some kind of rehaul, but I think the artistic benefit is a real one. If you wish to use this tool and adopt the same style, by all means feel free. In fact, I encourage it. But the tricky part about anything which confers the benefit of originality is that this benefit cannot be easily shared. + ## Install requirements ```sh