resources/lib/codex-icons/README.md

   1 # @wikimedia/codex-icons
   2
   3 Codex is the design system for Wikimedia.
   4
   5 This package contains Codex icons and utility functions needed to work with them.
   6
   7 Icons apply the "WikimediaUI" visual style of the Wikimedia Foundation. See [icons style guide](https://doc.wikimedia.org/codex/latest/style-guide/icons.html) for the principles guiding icon design.
   8
   9 See 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.
  10
  11 ## Usage
  12
  13 See the [installation](https://doc.wikimedia.org/codex/main/using-codex/usage.html#installation) and [using icons](https://doc.wikimedia.org/codex/main/using-codex/usage.html#using-icons) documentation for information about how to use Codex icons in your application.
  14
  15 ## License to adapt and remix
  16
  17 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
  18 in and beyond the Wikimedia movement.
  19
  20 ## Building from source
  21
  22 For information about building icons from the source code, see [BUILDING.md](./BUILDING.md).