Mirrors/stylix
2
0
Fork 0
mirror of https://github.com/danth/stylix synced 2024-11-10 06:34:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

Edit documentation around colour schemes ✏️

Browse source
This commit is contained in:
Daniel Thwaites 2022-09-27 08:33:08 +00:00 committed by GitHub
parent cd9788bba6
commit f2161fc629
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -66,10 +66,11 @@ The wallpaper is the only option which is required!
### Automatic color schemes ### Automatic color schemes
If you only set a wallpaper, Stylix will use a homemade If you only set a wallpaper, Stylix will use a
[genetic algorithm](https://en.wikipedia.org/wiki/Genetic_algorithm) [genetic algorithm](https://en.wikipedia.org/wiki/Genetic_algorithm)
to choose a color scheme based on it. The quality of the generated palettes can to choose a color scheme based on it. The quality of these automatically
vary - but more colorful images tend to have better results. generated schemes can vary, but more colorful images tend to have better
results.
You can force a light or dark theme using the polarity option: You can force a light or dark theme using the polarity option:
@ -79,8 +80,8 @@ stylix.polarity = "dark";
### Mixed color schemes ### Mixed color schemes
You can override part of the scheme by hand, perhaps to select your background You can override part of the scheme by hand, perhaps to select background
and text colors manually while keeping the genetic accent colors: and text colors manually while keeping the generated accent colors:
```nix ```nix
stylix.palette = { stylix.palette = {
@ -96,15 +97,16 @@ The `baseXX` names correspond to
### Manual color schemes ### Manual color schemes
Alternatively, you can use a pre-made colorscheme from Alternatively, you can use a pre-made colorscheme from
[the base16 repository](https://github.com/base16-project/base16-schemes): [the base16 repository](https://github.com/base16-project/base16-schemes).
```nix ```nix
stylix.base16Scheme = "${base16-schemes}/gruvbox-dark-hard.yaml"; stylix.base16Scheme = "${base16-schemes}/gruvbox-dark-hard.yaml";
``` ```
If you want anything more complex - like running an external palette generator If you want to do anything more complex - such as running your own program to
program - `base16Scheme` can accept any argument to generate the colour scheme - `base16Scheme` can accept any argument which
[`mkSchemeAttrs`](https://github.com/SenchoPens/base16.nix/blob/main/DOCUMENTATION.md#mkschemeattrs). [`mkSchemeAttrs`](https://github.com/SenchoPens/base16.nix/blob/main/DOCUMENTATION.md#mkschemeattrs)
supports.
## Fonts ## Fonts