Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add build from source doc to CONTRIBUTING.md #48

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

adhulipa
Copy link
Contributor

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.

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.
@@ -3,6 +3,14 @@
We want to make contributing to this project as easy and transparent as
possible.

## Build from Source
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants