Readme.md: rework build instructions #12757
Conversation
This commit's primary goals are to remove duplication in build instructions, and to reduce the total time spent compiling when following the instructions: - Recommend using Ninja with CMake, the compilation time is 11% faster with Ninja on my machine. - Recommend shallow fetches to speed up downloads. - Reduce repetition of build instructions across platforms by documenting a step-by-step compilation approach with shared steps between OSes. - Recommend shorter, standard CMake flags (`-B` and `--build`) instead of calling the generated build system directly and working around its limitations. - Syntax highlight Shell examples. - Let Ninja figure out the job count. A cursory look at its source code indicates it takes more than just core count into account, it also understands CGroups and processor affinities. - Fix lack of commas where necessary in the lines we've modified. - Break up lines over 80 characters in the parts of the text we've modified. This doesn't affect presentation in Markdown. - Title the Windows uninstall instructions "Microsoft Windows uninstall" to avoid having multiple sections named "Microsoft Windows," as it would prevent linking all but the first.
There was a problem hiding this comment.
I'm a bit torn on the code blocks. I like them better than the previous numbered lists (since copying those is a pain to do,) but the new ones are basically one command strung together. The line breaks help though, appreciate those.
One-liners are not always easier to read (IMO: never?) so I try to avoid those in anything that is supposed to live longer than an hour or will be seen by anyone other than myself. They only make sense in my head when there's no other way to do it, like passing thru values by piping commands together. And those are distinct commands that have their own effect.
Thats just my personal opinion though, if everyone else wants to keep them, I'll follow suit. Just keep in mind that those will be read by a lot of different people, and many probably also want to understand them.
I've only tested the instructions on OpenBSD 7.5 amd64. I haven't tested the uninstall instructions because it turns out installation is broken, it doesn't respect a custom installation prefix specified by e.g.
cmake --install build --prefix /tmp/dolphin, and I don't want to pollute my system installation prefix.You can preview how it looks at guijan/dolphin/tree/build-inst
Perhaps, if this new text is accepted, a future PR could move the new instructions to Dolphin's Github Wiki to further remove duplication between the wiki and the readme? Or, because the wiki is not included in a checkout, move the wiki's instructions (not necessarily verbatim) to the readme.
Edit: the force-push was just to remove accidental tabs in the commit message.