From 37c8b611ce4dfc0bab427d613d41cfb3fd75db0d Mon Sep 17 00:00:00 2001 From: Aditya Dhulipala Date: Sat, 16 Mar 2024 13:10:56 -0700 Subject: [PATCH] Add build from source doc to CONTRIBUTING.md 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. --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 67e4829b..3090ca73 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,6 +3,14 @@ We want to make contributing to this project as easy and transparent as possible. +## Build from Source +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 git@github.com: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.