Rename BUILD.txt to BUILD.md and rewrite #1323
Merged
Conversation
This file contains 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
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.
In anticipation of wanting to document the upcoming CMake build system, I rewrote the existing BUILD.txt file. It was already a valid markdown file before I began so I renamed it to BUILD.md first.
I changed the destination in your SDL installation example from /usr/bin to /usr/local/bin since on macOS and maybe other operating systems /usr/bin is for things installed by the operating system while /usr/local/bin is for things installed by the user.
Your BUILD.txt file didn't address the Qt UI or building on Windows and I haven't attempted to address that in this rewrite either.
I hard wrapped the file at 80 characters because diffs of long lines are difficult to read.
Let me know if you want any of this to be different.