(sdl3 branch) INSTALL: Add second-level headings for readability#266
Open
0cjs wants to merge 1 commit into
Open
(sdl3 branch) INSTALL: Add second-level headings for readability#2660cjs wants to merge 1 commit into
0cjs wants to merge 1 commit into
Conversation
The second-level headings make it significantly easier to see, e.g., where the prerequisites sections for the various platforms end and the build instructions begin. It's now possible just to quickly scan through the file in your editor and see the four major sections. The first-level heading is changed to Markdown "underlined" format so it stands out as it should rather than looking like a comment.
Contributor
Author
|
BTW, if "merging" this is actually going to produce a merge commit, it's probably easier and cleaner just to cherry-pick the commit itself into your branch and close this unmerged. |
maxolasersquad
force-pushed
the
sdl3
branch
7 times, most recently
from
00ab770 to
351255a
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The second-level headings make it significantly easier to see, e.g., where the prerequisites sections for the various platforms end and the build instructions begin. It's now possible just to quickly scan through the file in your editor and see the four major sections.
The first-level heading is changed to Markdown "underlined" format so it stands out as it should rather than looking like a comment.