-
Notifications
You must be signed in to change notification settings - Fork 2.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: improve installation FAQ's #3670
docs: improve installation FAQ's #3670
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A lot of the stuff here is mentioned in the installation guide. It might be more helpful to include the choco
warning in there, and reference the installation docs for things like changing $PATH
.
It might be a good idea to also add a troubleshooting section to the installation guide with manim checkhealth
and asking users to make sure they only have one python on their system.
Thanks for helping make Manim better ✨
P.S: the linked to the changed documentation is here: https://manimce--3670.org.readthedocs.build/en/3670/faq/installation.html#windows-problem-with-installation-process
not the stable link ;)
So, maybe I will add a new section here for the simple installation. Without any additional features like choco, scoop, or virtual environments? |
I see one problem. When I was installing manim, with cleaning pytnon installation. I have two version of python. The only thing i did is pure python installation and after that pip install manim. Potentially this is a common problem. |
One thing comes to my mind: why can't we create from 3 files, one for each operating system where all things will be installed manually? ffmpeg could be installed if we download these three files. Manim is trivial to install, the only thing I need to check is Miktex installation from the terminal. The official documentation for MiKTeX said that it is possible. What do you think? For really lazy people, it could potentially be a blessing. Download one file and forget about the whole universe 😀 |
The installation is already covered on that page, but a section on troubleshooting could help, maybe?
So, an installer? Regardless, that would be a different matter than what the PR is about, so it should be discussed elsewhere. |
|
…ing manim, and using virtual environments
Overview: What does this pull request change?
I added it because it is so common that in Windows installation has failed and in almost all cases this approach, presented in the section of docs is working.
Motivation and Explanation: Why and how do your changes improve the library?
Links to added or changed documentation pages
https://docs.manim.community/en/stable/faq/installation.html#different-versions
Further Information and Comments
Reviewer Checklist