Fix and clean up BUILD.md #2319
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
abey79
added
📖 documentation
3 tasks
emilk
pushed a commit
that referenced
this pull request
Jun 15, 2023
### What This PR cleans up and fixes the basic build steps in BUILD.md. I'm moved and structured a few things around to make the progression nicer for new developers. I also introduced the `just` commands for setting up and building the Python SDK. For windows, I've had to make some assumptions since the `just file` doesn't support windows and I dont have a test computer: - I assumed the `maturin develop` command is the same as on Mac/Linux - I assumed and the pre-pip-21.3 remark about `--use-feature=in-tree-build` is no longer necessary as `maturin` is used for installation ### Checklist * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [ ] ~~I've included a screenshot or gif (if applicable)~~ <!-- This line will get updated when the PR build summary job finishes. --> PR Build Summary: https://build.rerun.io/pr/2319 <!-- pr-link-docs:start --> Docs preview: https://rerun.io/preview/fb10bef/docs <!-- pr-link-docs:end -->
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.
What
This PR cleans up and fixes the basic build steps in BUILD.md. I'm moved and structured a few things around to make the progression nicer for new developers. I also introduced the
justcommands for setting up and building the Python SDK.For windows, I've had to make some assumptions since the
just filedoesn't support windows and I dont have a test computer:maturin developcommand is the same as on Mac/Linux--use-feature=in-tree-buildis no longer necessary asmaturinis used for installationChecklist
I've included a screenshot or gif (if applicable)PR Build Summary: https://build.rerun.io/pr/2319
Docs preview: https://rerun.io/preview/fb10bef/docs