rose-pine-nix/README.md

173 lines
4.9 KiB
Markdown
Raw Normal View History

2023-03-26 18:14:56 -07:00
<h3 align="center">
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/logos/exports/1544x1544_circle.png" width="100" alt="Logo"/><br/>
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
2023-03-26 18:57:23 -07:00
Catppuccin for <a href="https://nixos.org">Nix</a>
2023-03-26 18:14:56 -07:00
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
</h3>
<p align="center">
2023-04-14 20:46:58 -07:00
<a href="https://github.com/catppuccin/nix/stargazers"><img src="https://img.shields.io/github/stars/catppuccin/nix?colorA=363a4f&colorB=b7bdf8&style=for-the-badge"></a>
<a href="https://github.com/catppuccin/nix/issues"><img src="https://img.shields.io/github/issues/catppuccin/nix?colorA=363a4f&colorB=f5a97f&style=for-the-badge"></a>
<a href="https://github.com/catppuccin/nix/contributors"><img src="https://img.shields.io/github/contributors/catppuccin/nix?colorA=363a4f&colorB=a6da95&style=for-the-badge"></a>
2023-03-26 18:14:56 -07:00
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/previews/preview.webp"/>
</p>
## Previews
<details>
<summary>🌻 Latte</summary>
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/previews/latte.webp"/>
</details>
<details>
<summary>🪴 Frappé</summary>
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/previews/frappe.webp"/>
</details>
<details>
<summary>🌺 Macchiato</summary>
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/previews/macchiato.webp"/>
</details>
<details>
<summary>🌿 Mocha</summary>
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/previews/mocha.webp"/>
</details>
## Usage
2023-04-14 20:46:58 -07:00
1. Import the [NixOS](https://nixos.org) and [home-manager](https://github.com/nix-community/home-manager) modules
<details>
<summary>With Flakes</summary>
```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
];
};
};
}
```
</details>
<details>
<summary>With Nix Channels</summary>
```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/nixos>
<catppuccin/modules/nixos>
];
home-manager.users.user = {
modules = [
<catppuccin/modules/home-manager>
];
};
}
```
For [standalone installations](https://nix-community.github.io/home-manager/index.html#sec-install-standalone)
```nix
_: {
imports = [
<catppuccin/modules/home-manager>
];
home.username = "user";
home.homeDirectory = "user";
programs.home-manager.enable = true;
}
```
</details>
2. Choose your desired flavour with `catppuccin.flavour`
```nix
_: {
catppuccin.flavour = "mocha";
}
```
3. Enable for supported programs with `catppucin.enable = true;`
```nix
_: {
programs.starship = {
enable = true;
catppuccin.enable = true;
};
}
```
2023-03-26 18:14:56 -07:00
## 🙋 FAQ
2023-04-14 20:46:58 -07:00
- 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)
2023-03-26 18:14:56 -07:00
## 💝 Thanks to
- [Stonks3141](https://github.com/Stonks3141)
2023-04-14 20:46:58 -07:00
- [getchoo](https://github.com/getchoo)
2023-03-26 18:14:56 -07:00
&nbsp;
<p align="center">
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/footers/gray0_ctp_on_line.svg?sanitize=true" />
</p>
<p align="center">
Copyright &copy; 2023-present <a href="https://github.com/catppuccin" target="_blank">Catppuccin Org</a>
2023-03-26 18:14:56 -07:00
</p>
<p align="center">
<a href="https://github.com/catppuccin/catppuccin/blob/main/LICENSE"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a>
</p>