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

Update README

Browse source
This commit is contained in:
DwarfMaster 2023-02-04 17:34:12 +01:00
parent 6fa03db360
commit 4bf7974c6d
1 changed files with 18 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -20,10 +20,6 @@ for example:
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
home-manager = {
url = "github:nix-community/home-manager";
inputs.nixpkgs.follows = "nixpkgs";
};
stylix.url = "github:danth/stylix";
};
@ -31,7 +27,6 @@ for example:
nixosConfigurations."<hostname>" = nixpkgs.lib.nixosSystem {
system = "x86_64-linux";
modules = [
home-manager.nixosModules.home-manager
stylix.nixosModules.stylix
];
};
@ -39,8 +34,13 @@ for example:
}
```
Stylix relies on [Home Manager](https://github.com/nix-community/home-manager)
for a lot of its work, so that needs to be imported too.
If [Home Manager](https://github.com/nix-community/home-manager) home-manager is available,
stylix with also import the home-manager module into it (can be disabled with
`stylix.homeManagerIntegration.enable = false`), and the system theme will be used
by default for each user theme.
If you want to use the home-manager module on its own, you need to import the
`homeManagerModules.stylix` output of the flake in your configuration.
## Wallpaper
@ -60,7 +60,9 @@ stylix.image = pkgs.fetchurl {
};
```
The wallpaper is the only option which is required!
The wallpaper is the only option which is required! On home-manager used from a NixOS
configuration, the system image will be used by default, thus nothing is required at
all.
## Color scheme
@ -81,22 +83,6 @@ stylix.polarity = "dark";
The generated scheme can be viewed in a web browser at
`file:///etc/stylix/palette.html`.
### Mixed color schemes
You can override part of the scheme by hand, perhaps to select background
and text colors manually while keeping the generated accent colors:
```nix
stylix.palette = {
base00 = "000000";
# ...
base07 = "ffffff";
};
```
The `baseXX` names correspond to
[this table](https://github.com/chriskempson/base16/blob/main/styling.md#styling-guidelines).
### Manual color schemes
Alternatively, you can choose a pre-made colorscheme from
@ -123,6 +109,11 @@ generate the colour scheme - `base16Scheme` can accept any argument which
[`mkSchemeAttrs`](https://github.com/SenchoPens/base16.nix/blob/main/DOCUMENTATION.md#mkschemeattrs)
supports.
If the system `base16Scheme` is set this way, it will be used as default for the
corresponding `home-manager` option only if the user config has the same image. If
the user has changed the image, the default value will be the generated color scheme
from this picture.
## Fonts
The default combination of fonts is:
@ -180,3 +171,6 @@ styling on or off. Normally, it's turned on automatically when the target is
installed. You can set `stylix.autoEnable = false` to opt out of this
behaviour, in which case you'll need to manually enable each target you want to
be styled.
Targets are different between home-manager and NixOS, and sometimes available
in both cases. If both are available, it is always correct to enable both.