diff --git a/docs/LOGO_USAGE.md b/docs/LOGO_USAGE.md new file mode 100644 index 0000000000..47b83e0de6 --- /dev/null +++ b/docs/LOGO_USAGE.md @@ -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 +
+
+ MLX logo © 2023 Apple Inc.
+
+ MLX logo © 2023 Apple Inc. | + Learn more +
+