https://github.com/numixproject/numix-core
Builder for App Icon Themes
https://github.com/numixproject/numix-core
Last synced: about 1 year ago
JSON representation
Builder for App Icon Themes
- Host: GitHub
- URL: https://github.com/numixproject/numix-core
- Owner: numixproject
- License: gpl-3.0
- Created: 2013-11-10T11:20:24.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2025-03-02T21:33:43.000Z (over 1 year ago)
- Last Synced: 2025-04-13T17:46:48.635Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 61.9 MB
- Stars: 766
- Watchers: 31
- Forks: 148
- Open Issues: 176
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Numix Core
[](https://numixproject.org/) [](https://github.com/numixproject/numix-core/actions/workflows/test.yml)
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](https://github.com/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](https://github.com/numixproject/numix-core/issues/new/choose) or [read this page](https://github.com/numixproject/numix-core/wiki/Requesting-Icons) for more information.
### Contributions
We accept contributions, read [this page](.github/CONTRIBUTING.md#Icons) for more info. If you're interested in taking up maintenance of an unmaintained theme then [get in touch](mailto:numixproject@gmail.com).
### Hardcoded Icons
To deal with hardcoded application icons Numix uses the [hardcode-fixer](https://github.com/Foggalong/hardcode-fixer) script. A list of the applications supported by the script can be found [here](https://github.com/Foggalong/hardcode-fixer/wiki/App-Support).
## Script
This repo also contains [gen.py](https://github.com/numixproject/numix-core/blob/master/gen.py), the code used for building the icon themes. The Linux themes in particular are then packaged using [this script](https://github.com/numixproject/numix-tools/blob/master/numix-tools/package.sh) into [Circle](https://github.com/numixproject/numix-icon-theme-circle) and [Square](https://github.com/numixproject/numix-icon-theme-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](https://cairographics.org/) or [Inkscape](https://inkscape.org/). The macOS packaging needs [libicns](http://icns.sourceforge.net/) for the `png2icns` command. More information can be found [in our wiki](https://github.com/numixproject/numix-core/wiki/Dependencies).
### How To Use
1. [Download](https://github.com/numixproject/numix-core/archive/refs/heads/master.zip) the repo
2. Run `gen.py --theme {circle,square} --platform {android,linux,osx}`
3. Get your generated package
### Tests
The [tests/](https://github.com/numixproject/numix-core/tree/master/tests) directory contains several tests for making sure the [data.json](data.json) is valid. We also use [flake8](https://flake8.pycqa.org/), [markdownlint](https://github.com/DavidAnson/markdownlint), and [editorconfig](.editorconfig) for linting.