Skip to content
Closed
Changes from all commits
Commits
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
109 changes: 109 additions & 0 deletions docs/LOGO_USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# MLX Logo Usage Guidelines

## License

The MLX logo is part of the MLX project and is licensed under the [MIT License](../LICENSE).

**Copyright:** © 2023 Apple Inc.

## Available Formats

### PNG Versions (Current)

- **Light mode:** [`docs/src/_static/mlx_logo.png`](src/_static/mlx_logo.png) (924×924px, 76KB)
- **Dark mode:** [`docs/src/_static/mlx_logo_dark.png`](src/_static/mlx_logo_dark.png) (924×924px, 48KB)

### SVG Version

**Status:** Not yet available. See [Issue #3291](https://github.com/ml-explore/mlx/issues/3291).

We welcome contributions to add SVG versions of the logo. If you're interested in creating one, please:
1. Comment on [Issue #3291](https://github.com/ml-explore/mlx/issues/3291)
2. Ensure the SVG accurately represents the existing PNG design
3. Submit a PR following our [Contributing Guidelines](../CONTRIBUTING.md)

## Attribution Requirements

When using the MLX logo:

### Minimal Attribution (Required)

Include this notice near the logo or in your project's attribution section:

```
MLX logo © 2023 Apple Inc.
```

### Recommended Attribution (Preferred)

For better context, we recommend:

```
MLX logo © 2023 Apple Inc.
MLX is an open-source machine learning framework for Apple silicon.
https://github.com/ml-explore/mlx
```

### Example Usage in Markdown

```markdown
<div align="center">
<img src="https://github.com/ml-explore/mlx/blob/main/docs/src/_static/mlx_logo.png"
alt="MLX Logo" width="200" />

<p><em>MLX logo © 2023 Apple Inc.</em></p>
</div>
```

### Example Usage in HTML

```html
<div style="text-align: center;">
<img src="mlx_logo.png" alt="MLX Logo" width="200" />
<p><small>MLX logo © 2023 Apple Inc. |
<a href="https://github.com/ml-explore/mlx">Learn more</a>
</small></p>
</div>
```

## Permitted Uses

Under the MIT License, you may:

- ✅ Use the logo in documentation for projects using MLX
- ✅ Use the logo in educational materials about MLX
- ✅ Use the logo in presentations or blog posts discussing MLX
- ✅ Modify the logo (with attribution to the original)
- ✅ Use commercially (with attribution)

## Best Practices

### Do

- ✅ Provide clear attribution
- ✅ Link back to the MLX project
- ✅ Maintain aspect ratio when resizing
- ✅ Use appropriate format (light/dark) for your background

### Don't

- ❌ Remove or obscure the attribution
- ❌ Imply official endorsement without permission
- ❌ Use the logo as your own project's primary branding
- ❌ Distort or alter the logo in misleading ways

## Trademark Notice

"MLX" and the MLX logo are trademarks or registered trademarks of Apple Inc.

Use of the logo does not grant trademark rights. If you're unsure whether your use case is appropriate, please reach out to the MLX maintainers via [GitHub Discussions](https://github.com/ml-explore/mlx/discussions).

## Questions?

- **General logo questions:** [Issue #3291](https://github.com/ml-explore/mlx/issues/3291)
- **Usage questions:** [GitHub Discussions](https://github.com/ml-explore/mlx/discussions)
- **Bug reports:** [Issues](https://github.com/ml-explore/mlx/issues)

---

_This document provides guidance for logo usage. For questions not covered here, please refer to the [MIT License](../LICENSE) or contact the maintainers._