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

Remove non-flake installation method from README 📝

Browse source
This commit is contained in:
Daniel Thwaites 2021-12-17 17:11:19 +00:00
parent 38d8ca1f58
commit acd7a92cab
No known key found for this signature in database
GPG key ID: D8AFC4BF05670F9D
1 changed files with 16 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
README.md
View file

@ -5,51 +5,38 @@ built upon ideas from [Base16](http://chriskempson.com/projects/base16/).
## Installation
Import `default.nix` into your system configuration:
```nix
{ pkgs, ... }:
let stylix = pkgs.fetchFromGitHub {
owner = "danth";
repo = "stylix";
rev = "...";
sha256 = "...";
};
in {
imports = [ "${stylix}/default.nix" ];
}
```
### Home Manager
Stylix relies on [Home Manager](https://github.com/nix-community/home-manager)
to install a lot of its theming. This requires Home Manager to be installed as
a NixOS module, if you do not already have that set up you will need to follow
[these instructions](https://rycee.gitlab.io/home-manager/index.html#sec-install-nixos-module).
### Nix Flakes
Stylix can also be installed using the experimental
Stylix can be installed using the experimental
[flakes](https://nixos.wiki/wiki/Flakes) feature:
```nix
{
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";
};
outputs = { self, nixpkgs, stylix }: {
outputs = { self, nixpkgs, home-manager, stylix }: {
nixosConfigurations."<hostname>" = nixpkgs.lib.nixosSystem {
system = "x86_64-linux";
modules = [ stylix.nixosModules.stylix ];
modules = [
home-manager.nixosModules.home-manager
stylix.nixosModules.stylix
];
};
};
}
```
Stylix relies on [Home Manager](https://github.com/nix-community/home-manager)
to install a lot of its theming. This requires Home Manager to be installed as
a NixOS module; how to do this is shown in the example above. Users must be
listed in `stylix.homeManagerUsers` to enable styles which rely on Home Manager
for that user.
## Configuration
```nix