diff --git a/README.md b/README.md index 49f46a8..9c6ffc5 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@

- - - + + +

@@ -36,20 +36,136 @@ ## Usage -1. Clone this repository locally -2. Open the app's settings -3. Select `import theme` and browse to where you cloned Catppuccin -4. Select it +1. Import the [NixOS](https://nixos.org) and [home-manager](https://github.com/nix-community/home-manager) modules + +

+With Flakes + +```nix +{ + inputs = { + nixpkgs.url = "nixpkgs/nixos-22.11"; + catppuccin.url = "github:catppuccin/nix"; + home-manager = { + url = "github:nix-community/home-manager"; + inputs.nixpkgs.follows = "nixpkgs"; + }; + }; + + outputs = { nixpkgs, catppuccin, home-manager }: let + system = "x86_64-linux"; + pkgs = import nixpkgs {inherit system;}; + in { + # for nixos module home-manager installations + nixosConfigurations.host = pkgs.lib.nixosSystem { + inherit system; + modules = [ + catppuccin.nixosModules.catppuccin + home-manager.nixosModules.home-manager + { + home-manager.users.user = { + modules = [ + catppuccin.homeManagerModules.catppuccin + ]; + }; + } + ]; + }; + + # for standalone home-manager installations + homeConfigurations.user = home-manager.lib.homeManagerConfiguration { + inherit pkgs; + modules = [ + catppuccin.homeManagerModules.catppuccin + ]; + }; + }; +} +``` + +
+ +
+With Nix Channels + +```bash +sudo nix-channel --add https://github.com/nix-community/home-manager/archive/master.tar.gz home-manager +sudo nix-channel --add https://github.com/catppuccin/nix/archive/main.tar.gz catppuccin +sudo nix-channel --update +``` + +For [NixOS module installations](https://nix-community.github.io/home-manager/index.html#sec-install-nixos-module): + +```nix +_: { + imports = [ + + + ]; + + home-manager.users.user = { + modules = [ + + ]; + }; +} + +``` + +For [standalone installations](https://nix-community.github.io/home-manager/index.html#sec-install-standalone) + +```nix +_: { + imports = [ + + ]; + + home.username = "user"; + home.homeDirectory = "user"; + programs.home-manager.enable = true; +} +``` + +
+ +2. Choose your desired flavour with `catppuccin.flavour` + +
+Example + +```nix +_: { + catppuccin.flavour = "mocha"; +} +``` + +
+ +3. Enable for supported programs with `catppucin.enable = true;` + +
+Example + +```nix +_: { + programs.starship = { + enable = true; + catppuccin.enable = true; + }; +} +``` + +
- ## 🙋 FAQ -- Q: **_"Where can I find the doc?"_**\ - A: Run `:help theme` +- Q: **"How do I know what programs are supported?"**\ + A: You can find supported programs [here](https://github.com/catppuccin/nix/tree/main/modules/home-manager) ## 💝 Thanks to - [Stonks3141](https://github.com/Stonks3141) +- [getchoo](https://github.com/getchoo)