Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
T-Dynamos committed Jan 13, 2024
1 parent 694815f commit 0a47dfa
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion materialyoucolor/utils/theme_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 0a47dfa

Please sign in to comment.