Move installation details from README to the installation guide #38659
+1,139
−1,092
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently we have two docs for installation: README.md and the Sage Installation Guide. There are severe problems:
This PR aims to make README.md a light-weight easy-to-follow installation guide for newcomers and beginners trying to install Sage to their personal computers.
See the new README:
https://github.com/kwankyu/sage/tree/p/streamline-installation-guide#getting-started
The new README does not try to be comprehensive. That is the role of the Sage Installation Guide. Materials removed from README are incorporated to the Sage Installation Guide. The Sage Installation Guide would provide all the details for users for whom the README.md is not sufficient.
The installation guide in README was tested with macOS, ubuntu, Windows WSL (ubuntu and fedora).
Along the way, I made extensive edits on the Sage Installation Guide. Most of them are non-technical.
See the new Sage Installation Guide:
https://doc-pr-38659--sagemath.netlify.app/html/en/installation/
In future, there would be little need to update the installation guide in README. Developers could focus only on updating the Sage Installation Guide as Sage evolves. This lessens maintenance burden.
📝 Checklist
⌛ Dependencies
#38676 to fix ci for doc preview