diff --git a/README.md b/README.md index 4c42e9c..a90b7ff 100644 --- a/README.md +++ b/README.md @@ -23,15 +23,14 @@ brew install cmake To build, run the following commands: ```shell -mkdir build && cd build -cmake .. -DCMAKE_BUILD_TYPE=Release -make -j +cmake -B build -DCMAKE_BUILD_TYPE=Release +cmake --build build ``` From the `build/` directory, you can run an [example](examples/example.c) that uses MLX C with `./example`. -## Contributing +## Contributing Check out the [contribution guidelines](CONTRIBUTING.md) for more information on contributing to MLX C. See the diff --git a/docs/src/install.rst b/docs/src/install.rst index 7994965..718972a 100644 --- a/docs/src/install.rst +++ b/docs/src/install.rst @@ -11,9 +11,8 @@ To build MLX C, run the following commands: .. code-block:: shell - mkdir build && cd build/ - cmake .. -DCMAKE_BUILD_TYPE=Release - make -j + cmake -B build -DCMAKE_BUILD_TYPE=Release + cmake --build build MLX C will fetch `MLX `_ under the hood, compile it, and then compile the C API.