Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
docs: install improvements #2293
These are multiple changes which probably don't belong into one pull request, but since some of them depend on each other, I've added them to just one branch.
The main intention of these changes was to rewrite the "Source code" section and suggest to rather use the
In order to keep the overall install page more simple, compact, precise and most importantly, consistent, I've also removed the shell prompts from each code block and added
As a last step, I have split the "other platforms" section into Windows and macOS and moved these two sections to the top. The reason for this is that people generally don't (want to) read and since these OSes are (unfortunately) more common, it's simply better to have them at the top of the document. The detailed Windows instructions are still at the bottom, which means that the old layout doesn't get changed that much. The section anchors however were renamed, which might break links from other documents or somewhere else, not sure.
As a reminder of how to build and see the docs locally:
make --directory=docs clean html chromium ./docs/_build/html/install.html &
@@ Coverage Diff @@ ## master #2293 +/- ## ======================================= Coverage 52.61% 52.61% ======================================= Files 237 237 Lines 14758 14758 ======================================= Hits 7765 7765 Misses 6993 6993