Separate build instructions for Windows and Unix into separate sections in README.md #664
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Will work out how best to fix the linter issues next week (almost all about now having duplicate headers). Feel free to provide feedback on the idea of the PR in the meantime though. I will stop the workflows for now, and they can run when I fix the linter issues. |
mcbarton
force-pushed
the
Neaten-readme-build-instrucgtions
branch
2 times, most recently
from
a0eddb2 to
f21a206
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #664 +/- ##
=======================================
Coverage 79.30% 79.30%
=======================================
Files 9 9
Lines 3876 3876
=======================================
Hits 3074 3074
Misses 802 802 🚀 New features to boost your workflow:
|
|
Now that the markdown linter is passing for this PR it is ready for review. |
Thanks for the feedback. I was thinking about this idea already, and will implement it sometime this week. |
mcbarton
force-pushed
the
Neaten-readme-build-instrucgtions
branch
from
f21a206 to
c2e265e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Please include a summary of changes, motivation and context for this PR.
There is a lot of back and forth in the build instructions in the readme for different platforms. To quickly get a set of instructions for either Windows or a Unix platform this PR arranges them into clickable sections when viewed on Github. e.g. it looks like this, where you click on the platform you want, to get the instructions just for that platform
To me this a lot cleaner, and easier for a beginner to decipher what exact instructions the user wants for their platform. To see how this looks in practice, and how it neatens everything up, see the branch of this PR https://github.com/mcbarton/CppInterOp/tree/Neaten-readme-build-instrucgtions
Fixes # (issue)
Type of change
Please tick all options which are relevant.
Testing
Please describe the test(s) that you added and ran to verify your changes.
Checklist