# @wikimedia/codex-icons

Codex is the design system for Wikimedia.

This package contains Codex icons and utility functions needed to work with them.

Icons apply the "WikimediaUI" visual style of the Wikimedia Foundation. Refer to [icons style guide](https://doc.wikimedia.org/codex/latest/style-guide/icons.html) for the principles guiding icon design.

Refer to the [icons overview documentation](https://doc.wikimedia.org/codex/latest/icons/overview.html) for links to a complete list of icons with demos and guidelines.

## Usage

Refer to the [installation](https://doc.wikimedia.org/codex/latest/using-codex/developing.html#installation) and [using icons](https://doc.wikimedia.org/codex/latest/using-codex/developing.html#using-icons) documentation for information about how to use Codex icons in your application.

## License to adapt and remix

The icons are freely licensed under [Creative Commons Attribution 4.0 (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/). Please let the Design System Team know when you're using those icons for projects
in and beyond the Wikimedia movement.

## Building from source

For information about building icons from the source code, refer to [BUILDING.md](./BUILDING.md).