diff --git a/README.md b/README.md index a7fc350..b7e1215 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,27 @@ Material You color algorithms for python (crossplatform)! +## Install + +You can easily install it from pip by executing: +```console +pip3 install materialyoucolor --upgrade +``` +Prebuilt binaries are avaliable for `linux`, `windows` and `macos`. + + ## Build and install -Install [abseil](https://abseil.io/) using system package manager. Currently it only supports MacOs and Linux, other platform support is comming soon. +It is built in reference with offical [typescript implementation](https://github.com/material-foundation/material-color-utilities/tree/main/typescript) but it's color quantization part is based on [c++ implementation](https://github.com/material-foundation/material-color-utilities/tree/main/cpp) thanks to [pybind](https://github.com/pybind). ```console # Install pybind 11 pip3 install pybind11 -pip3 install https://github.com/T-Dynamos/materialyoucolor-pyhton/archive/main.zip +pip3 install https://github.com/T-Dynamos/materialyoucolor-pyhton/archive/develop.zip ``` + +## FAQ + + 1. How it is different from `avanisubbiah/material-color-utilities`? + - See https://github.com/T-Dynamos/materialyoucolor-pyhton/issues/3 diff --git a/materialyoucolor/utils/theme_utils.py b/materialyoucolor/utils/theme_utils.py index 5d852b5..a58489e 100644 --- a/materialyoucolor/utils/theme_utils.py +++ b/materialyoucolor/utils/theme_utils.py @@ -46,7 +46,7 @@ def custom_color(custom_color, source_color=None, blend=False): } -def theme_from_source_color(source: int, custom_colors: list[CustomColor]) -> Theme: +def theme_from_source_color(source: int, custom_colors: list[int]) -> Theme: palette = CorePalette.of(source) return Theme( source,