Update README install and build guides#1673
Update README install and build guides#1673wolfpackmars2 wants to merge 1 commit intosolvespace:masterfrom
Conversation
Added instructions for installing via unofficial distro packages and additional information when building from source for various platforms. Changed header from "Via Source Code" to "Getting the source code". Added a target to not break existing links. Fix other small typos and grammar. Resolves solvespace#1654 and solvespace#1653
|
I've reviewed the entirety of the readme and propose a few changes for readability and to add additional information for reference. Particularly for users who wish to build/install on Linux. I moved the header "Via source code" from the Installation group and made a master header for building from source code. In this context, leaving the header as "via source code" didn't quite fit the new section. To prevent any existing web links to the old heading, I added a custom anchor to maintain the old links. |
|
This is too intrusive. The new information is superfluous (easy to google); the restructuring is unnecessary.
Moving the "building on OpenBSD" section - no. The grammar and spelling fixes are good. If you submit a PR with just them I'll merge it (or I'll make them myself). |
|
I apologize for my presumptuousness. |
|
@wolfpackmars2 you do not need to apologise. I appreciate the fact that after figuring out the And the grammatical and spelling errors you caught are really appreciated! Obviously no one read carefully enough before you :-) |
|
Thanks for the feedback @ruevs I remember why I was frustrated that day. I spend a lot of effort trying to provide quality PR while respecting the time of the core team. For this reason I spend a lot of time researching - for example, to try to identify if the code in its current state is intentional, and definitely to try to identify any way the change could negatively impact the project or the core team. I wasn't expecting pushback on my PR, which I see as fixing a typo. The concerns raised in the feedback there are separate from what the PR actually does, and I wasn't sure how to best respond or even if I should spend any more time on something that was going to be removed anyways. This isn't the first time I've been slapped back for suggesting structural changes to documentation, so indeed I take responsibility for overstepping in this regard. |
Not necessarily. Following good instructions to compile a program is easy. It doesn't require knowledge of how cmake works or how the project is set up for cmake. I have determined that sudo is not needed to install SS, and I wanted to provide the information so that people who aren't experienced specifically with cmake but who can build from source can have the choice without having to spend hours (like I did) to figure it out. I don't see why providing this information in the guide would cause a problem. If the information can be presented differently, or if the information causes other problems (ie confusion, is inaccurate, etc) then I would be receptive to such feedback. I can only accept your decision in my current position, but it would be helpful to me to understand the potential negative effects of adding this information. |
Added instructions for installing via unofficial distro packages and additional information when building from source for various platforms.
Changed header from "Via Source Code" to "Getting the source code". Added a target to not break existing links.
Fix other small typos and grammar.
Resolves #1654 and resolves #1653