Update docs for m1 mac build #110
Merged
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
tony-ricciardi
previously approved these changes
Nov 2, 2021
README.md
Outdated
| # run unit tests | ||
| ctest | ||
| ``` | ||
| export PYTH_REPO=`pwd` |
Contributor
There was a problem hiding this comment.
PYTH_REPO=/path/to/host/pyth-client might be more clear. If you'd rather to stick with pwd, it should be "$( pwd )" to handle whitespace and be consistent with the podman command below.
README.md
Outdated
|
|
||
| If you are using an M1 mac, you will need to build this repository inside a linux docker container, as the build depends on | ||
| some linux-specific libraries. You can run the following command to open a shell in a linux docker container with the current | ||
| directory mounted: |
Contributor
There was a problem hiding this comment.
I would remove the first sentence, since this isn't specific to OS X. I use a similar podman command on RHEL, and more generally users should always be building & running BPF binaries inside a docker environment.
| ``` | ||
|
|
||
| This command runs a recent pyth-client docker image that already has the necessary dependencies installed. | ||
| Therefore, once the container is running, all you have to do is run `cd pyth-client && ./scripts/build.sh`. |
Contributor
There was a problem hiding this comment.
Also worth noting that the --user argument causes changes to source files, build directories, etc., within the mounted ~/pyth-client/ to be persisted to the host (generally desired).
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.
No description provided.