stm32-cmake
stm32-cmake copied to clipboard
ObKo
README tweaks
- Additional example for HAL usage with the H7 family using two cores
- HTML ID achors for headings added
- Some minor formatting improvements and line breaks
- Additional usage example for setting the toolchain file
Hi,
I personally think that splitting the line like this does not bring any value for a maintainer (The line break changes does not github rendering). Maybe It does, but I cannot see it. Some cleaning is needed see #270, but none it's actually done here. I think it's better to close this PR without merging it.
Do you want to discard all the suggested changes? The anchors are useful to add cross-references inside the README and I think some of the additions increase the usability of the project (e.g. example of hardcoding the toolchain file in CMakeLists.txt to prevent setting the same one all the time).
About the line breaks: You don't see them in github, but I think it's nicer for someone who reads / edits them in a text editor
You are right on the lines breaks, as I said myself it does not change the generated html file. We can keep them.
The Usage section at the beginning of the file state that you can add multiple vars in different ways, and links to the exemples are provided. CMAKE_TOOLCHAIN_FILE is not in the list of those vars! It's assumed that people will know. Lets add there instead of at the end.