Skip to content

Latest commit

 

History

History
39 lines (21 loc) · 3.14 KB

README.md

File metadata and controls

39 lines (21 loc) · 3.14 KB

Numix Core

By The Numix Project Test

This repository powers the generation of the all the Numix app icon themes across all platforms. This new method is designed to make keeping themes on different platforms on feature parity easier as well as making it as simple as possible to add support for new platforms. Licensed under the GPL-3.0+ and maintained by @palob.

Artwork

This repo contains the artwork used for the Numix icon themes, split into the vibrant themes (Circle and Square) and the mono themes (uTouch and Shine). Only the Circle and Square vibrant themes are currently maintained but this script can build all.

Icon Requests

Please report icon requests in this repo using the appropriate issue template or read this page for more information.

Contributions

We accept contributions, read this page for more info. If you're interested in taking up maintenance of an unmaintained theme then get in touch.

Hardcoded Icons

To deal with hardcoded application icons Numix uses the hardcode-fixer script. A list of the applications supported by the script can be found here.

Script

This repo also contains gen.py, the code used for building the icon themes. The Linux themes in particular are then packaged using this script into Circle and Square.

Dependencies

The script needs Python 3.x to run. While the script can build themes for many platforms, running it is only officially supported on Linux. The exporting-to-PNG part of the script currently uses Cairo or Inkscape. The macOS packaging needs libicns for the png2icns command. More information can be found in our wiki.

How To Use

  1. Download the repo
  2. Run gen.py --theme {circle,square} --platform {android,linux,osx}
  3. Get your generated package

Tests

The tests/ directory contains several tests for making sure the data.json is valid. We also use flake8, markdownlint, and editorconfig for linting.