Skip to content

doc: use modern CMake invocation #87

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

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

doc: use modern CMake invocation #87

Show file tree
Hide file tree
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
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 2 additions & 3 deletions docs/src/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/ml-explore/mlx>`_ under the hood,
compile it, and then compile the C API.