Improve build docs #106
Merged
Improve build docs #106
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
probonopd
approved these changes
Dec 8, 2024
|
Build for testing: |
This commit eliminates redundancies between README.md and BUILD.md. Not having to maintain redundant documentation is a big improvement as there is no chance they will be out of sync. Plus, the docs in BUILD.md are a bit more sophisticated while still allowing @probonopd to copy-and-paste commands for his workflow. Additionally, the environment variable used in the chroot scripts has been fixed. The commit further adds a short introduction explaining the differences between the build scripts and recommending Docker for regular users.
TheAssassin
force-pushed
the
update-build-docs
branch
from
ab0ee99 to
8cb4786
Compare
|
Build for testing: |
1 similar comment
|
Build for testing: |
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.
This commit eliminates redundancies between README.md and BUILD.md. Not having to maintain redundant documentation is a big improvement as there is no chance they will be out of sync. Plus, the docs in BUILD.md are a bit more sophisticated while still allowing @probonopd to copy-and-paste commands for his workflow.
Additionally, the environment variable used in the chroot scripts has been fixed.
The commit further adds a short introduction explaining the differences between the build scripts and recommending Docker for regular users.