docs: correct build commands and Docker paths - #230
Merged
Merged
Conversation
Contributor
|
I will update a bit more the README as there is still some legacy for GreenAddress naming and etc. |
Contributor
|
LGTM, utACK |
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
2 participants
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.
Several README commands fail before a build can start: the macOS Homebrew line contains unquoted
(optional)text, the Windows option is missing a dash, and the Docker command references the removedtools/Dockerfile. The container examples also misspell/prebuildas/prebuid.This corrects those commands and paths, moves optional GNU tar installation into prose, and documents
--iphone staticand--iphonesim staticto match the argument parsers andgitlab/ios.yml. The Dockerfile path now matches the build command documented indocker/debian/Dockerfile.Validation:
git diff --checkand Bash syntax validation of the corrected Homebrew command passed. The original Homebrew command returned syntax error 2, and the original Windows spelling returned exit 1 in both build scripts. Docker paths and Apple arguments were checked against the current source and CI configuration. No full build, Homebrew installation, or Docker image build was run; the local Docker Linux engine was unavailable.