Add build from source doc to CONTRIBUTING.md #48
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
It took me a few failed Xcode builds to realize mlx-swift was a repo dependent on its sibling mlx-c and mlx projects; and that we're using `git submodules`. Perhaps its worth adding a few lines into the CONTRIBUTING.md doc.
davidkoski
reviewed
Mar 18, 2024
| @@ -3,6 +3,14 @@ | |||
| We want to make contributing to this project as easy and transparent as | |||
| possible. | |||
|
|
|||
| ## Build from Source | |||
There was a problem hiding this comment.
Maybe we could just link to the documentation?
I would prefer to have this info in one place in case we need to update it.
There was a problem hiding this comment.
Yes thanks for review & suggestion. I will update
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.
It took me a few failed Xcode builds to realize mlx-swift was a repo dependent on its sibling mlx-c and mlx projects; and that we're using
git submodules.Perhaps its worth adding a few lines into the CONTRIBUTING.md doc to explain how to clone & build from source in this instance.