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.

Sign up for GitHub

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
Open

Add build from source doc to CONTRIBUTING.md #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

We use git submodules to organize [mlx](https://github.com/ml-explore/mlx), [mlx-c](https://github.com/ml-explore/mlx-c), and [mlx-swift](https://github.com/ml-explore/mlx-swift) as a single project.

1. Clone mlx-swift `git clone [email protected]:ml-explore/mlx-swift.git`
1. Init submodules `git submodule init`
1. Update submodules `git submodule update --recursive`
1. Open your clonded `mlx-swift` folder in Xcode to build, edit, and debug

## Pull Requests

1. Fork and submit pull requests to the repo.
Expand Down