Update README instructions for cloning and building #4679
+4
−4
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
Git Large File Storage is required to clone the project. To build the project a container runtime (i.e. Docker Desktop) is required to be running locally. Signed-off-by: Robert McNees <[email protected]>
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.
Minor changes to the README to include two small tasks to get the code to clone and compile locally.
git-lfsis requiredGit Large File Storage is required to clone the project. Even with the command
GIT_LFS_SKIP_SMUDGE=1I still got the error:After a
brew install git-lfsthings worked fine. I verified after that theGIT_LFS_SKIP_SMUDGE=1did reduce the disk size of the download. Butgit-lfsseems to be a requirement.Run Docker Desktop
To build the project I needed a container runtime (i.e. Docker Desktop) running locally.