This commit is contained in:
Angel Ortigosa Perez
2026-02-12 17:45:06 +01:00
parent 6579882198
commit 2707e12133
80 changed files with 185 additions and 1489 deletions

19
lib/mlx/README.md Executable file → Normal file
View File

@@ -16,9 +16,6 @@ MLX42 is a performant, easy to use, cross-platform, minimal windowing graphics l
It provides primitive tools to draw textures onto the window as well as modifying them at runtime as they get displayed on the window.
> [!IMPORTANT]
> At times it may seem like no updates have taken place for a long time. This is expected, the project / lib is considered completed and requires minimal updates. Bug fixes are still guaranteed and the project is still being actively maintained.
# Features ✨
MLX42 comes with a plethora of features that make using it actually a joy instead of a chore.
@@ -42,14 +39,6 @@ It is built on OpenGL and uses batched rendering to speed up the rendering proce
## Open source && Community driven 🌐
This project is being actively maintained by Codam as well as students from the 42 Network. This gives students the direct opportunity to learn more about the library itself as well as fix any potential bugs instead of merely accepting them.
## Emscripten Compatibility 🚀
MLX42 introduces compatibility with [Emscripten](https://emscripten.org/), allowing MLX42 to run in web browsers through WebAssembly. This modification were made possible thanks to [@PepeLevi](https://github.com/PepeLevi/MLX42_emcc), credits to him for his fork and contributions.
### Highlights
- **Emscripten Support**: Compile MLX42 with Emscripten, enabling graphical applications to run in a web environment.
- **WebAssembly Compatibility**: Ensures that MLX42 can be utilized in modern web browsers, expanding its usability beyond traditional desktop environments.
- **Updated Documentation**: Provided guidance on how to build and run MLX42 projects using Emscripten.
---
## Installation 🏗️
@@ -117,14 +106,6 @@ You can pass build [options](./docs/index.md#available-options) to cmake, e.g: `
You can find an example makefile in the documentation [here](https://github.com/codam-coding-college/MLX42/blob/master/docs/Basics.md).
#### Bindings (Python, etc)
MLX42 currently has a [Python FFI binding](./ffi/python/README.md) available.
In order to get it working you need to build the library first as shown above.
The only change is that you need to enable the option `BUILD_SHARED_LIBS` when building with cmake:
```bash
cmake -B build -DBUILD_SHARED_LIBS=ON && cmake --build build --parallel
```
----
## For MacOS: