feat: Switch to Rose Pine readme
This commit is contained in:
parent
84bf107f49
commit
dabbef32d5
GPG key ID:
01823C057725C266
2 changed files with 43 additions and 215 deletions
215
README.md
215
README.md
|
|
@ -1,215 +0,0 @@
|
|||
<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"/>
|
||||
Catppuccin for <a href="https://nixos.org">Nix</a>
|
||||
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
|
||||
</h3>
|
||||
|
||||
<p align="center">
|
||||
<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>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/previews/preview.webp"/>
|
||||
</p>
|
||||
|
||||
## Previews
|
||||
|
||||
<details>
|
||||
<summary>🌻 Latte</summary>
|
||||
<img src="assets/previews/latte.webp"/>
|
||||
</details>
|
||||
<details>
|
||||
<summary>🪴 Frappé</summary>
|
||||
<img src="assets/previews/frappe.webp"/>
|
||||
</details>
|
||||
<details>
|
||||
<summary>🌺 Macchiato</summary>
|
||||
<img src="assets/previews/macchiato.webp"/>
|
||||
</details>
|
||||
<details>
|
||||
<summary>🌿 Mocha</summary>
|
||||
<img src="assets/previews/mocha.webp"/>
|
||||
</details>
|
||||
|
||||
## Usage
|
||||
|
||||
You will probably want to see our [Getting started guide](http://nix.catppuccin.com/getting-started/index.html), but as a TLDR:
|
||||
|
||||
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-unstable";
|
||||
catppuccin.url = "github:catppuccin/nix";
|
||||
home-manager = {
|
||||
url = "github:nix-community/home-manager";
|
||||
inputs.nixpkgs.follows = "nixpkgs";
|
||||
};
|
||||
};
|
||||
|
||||
outputs = { nixpkgs, catppuccin, home-manager }: {
|
||||
# for nixos module home-manager installations
|
||||
nixosConfigurations.pepperjacksComputer = pkgs.lib.nixosSystem {
|
||||
system = "x86_64-linux";
|
||||
modules = [
|
||||
catppuccin.nixosModules.catppuccin
|
||||
# if you use home-manager
|
||||
home-manager.nixosModules.home-manager
|
||||
|
||||
{
|
||||
# if you use home-manager
|
||||
home-manager.users.pepperjack = {
|
||||
imports = [
|
||||
./home.nix
|
||||
catppuccin.homeManagerModules.catppuccin
|
||||
];
|
||||
};
|
||||
}
|
||||
];
|
||||
};
|
||||
|
||||
# for standalone home-manager installations
|
||||
homeConfigurations.pepperjack = home-manager.lib.homeManagerConfiguration {
|
||||
pkgs = nixpkgs.legacyPackages.x86_64-linux;
|
||||
modules = [
|
||||
./home.nix
|
||||
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 = [
|
||||
<catppuccin/modules/nixos>
|
||||
# if you use home-manager
|
||||
<home-manager/nixos>
|
||||
];
|
||||
|
||||
# if you use home-manager
|
||||
home-manager.users.pepperjack = {
|
||||
imports = [
|
||||
<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 = "pepperjack";
|
||||
programs.home-manager.enable = true;
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
2. Choose your desired flavor with `catppuccin.flavor`
|
||||
|
||||
```nix
|
||||
{
|
||||
catppuccin.flavor = "mocha";
|
||||
}
|
||||
```
|
||||
|
||||
3. Enable for supported programs with `catppucin.enable = true;`
|
||||
|
||||
```nix
|
||||
{
|
||||
programs.starship = {
|
||||
enable = true;
|
||||
catppuccin.enable = true;
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
4. Enable for all available programs you're using!
|
||||
|
||||
```nix
|
||||
{
|
||||
catppuccin.enable = true;
|
||||
}
|
||||
```
|
||||
|
||||
## 🙋 FAQ
|
||||
|
||||
- Q: **"How do I know what programs are supported?"**\
|
||||
A: You can find programs supported through home-manager [here](https://nix.catppuccin.com/options/home-manager-options.html),
|
||||
and NixOS modules [here](https://nix.catppuccin.com/options/nixos-options.html)
|
||||
|
||||
- Q: **"How do I set `catppuccin.enable` for everything I use?"**\
|
||||
A: You can set `catppuccin.enable` [globally](https://nix.catppuccin.com/options/home-manager-options.html#catppuccinenable)
|
||||
|
||||
- Q: **"What versions of NixOS and home-manager are supported?"**\
|
||||
A: We primarily support the `unstable` branch, but try our best to support the current stable release.
|
||||
You can check if your stable release is currently supported at [status.nixos.org](https://status.nixos.org/)
|
||||
|
||||
- Q: **"How do I fix the error: ... during evaluation because the option 'allow-import-from-derivation' is disabled"**\
|
||||
A: Some ports need to read and/or manipulate remote resources, resulting in Nix performing [IFD](https://nix.dev/manual/nix/latest/language/import-from-derivation).
|
||||
|
||||
<details>
|
||||
<summary>Disable modules that use IFD</summary>
|
||||
|
||||
```nix
|
||||
{
|
||||
programs = {
|
||||
cava.catppuccin.enable = false;
|
||||
gh-dash.catppuccin.enable = false;
|
||||
imv.catppuccin.enable = false;
|
||||
swaylock.catppuccin.enable = false;
|
||||
};
|
||||
|
||||
services = {
|
||||
mako.catppuccin.enable = false;
|
||||
};
|
||||
}
|
||||
```
|
||||
</details>
|
||||
|
||||
## 💝 Thanks to
|
||||
|
||||
- [Stonks3141](https://github.com/Stonks3141)
|
||||
- [getchoo](https://github.com/getchoo)
|
||||
|
||||
|
||||
|
||||
<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 © 2023-present <a href="https://github.com/catppuccin" target="_blank">Catppuccin Org</a>
|
||||
</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>
|
||||
43
readme.md
Normal file
43
readme.md
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
<p align="center">
|
||||
<img src="https://github.com/rose-pine/rose-pine-theme/raw/main/assets/icon.png" width="80" />
|
||||
<h2 align="center">Rosé Pine for Nix</h2>
|
||||
</p>
|
||||
|
||||
<p align="center">All natural pine, faux fur and a bit of soho vibes for the classy minimalist</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/rose-pine/rose-pine-theme">
|
||||
<img src="https://img.shields.io/badge/community-rosé%20pine-26233a?labelColor=191724&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjUwIiBoZWlnaHQ9IjIzNyIgdmlld0JveD0iMCAwIDI1MCAyMzciIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CjxwYXRoIGQ9Ik0xNjEuMjI3IDE2MS4yNTFDMTMyLjE1NCAxNjkuMDQxIDExNC45MDEgMTk4LjkyNCAxMjIuNjkxIDIyNy45OTdDMTIzLjkyNSAyMzIuNjAzIDEyOC42NTkgMjM1LjMzNiAxMzMuMjY0IDIzNC4xMDJMMTg1LjkwNyAyMTkuOTk2QzIxOS41ODUgMjEwLjk3MiAyMzkuNTcgMTc2LjM1NCAyMzAuNTQ2IDE0Mi42NzdMMTYxLjIyNyAxNjEuMjUxWiIgZmlsbD0iIzI0NjI3QiIvPgo8cGF0aCBkPSJNODguMTgzNiAxNTkuOTg4QzExNy4yNTcgMTY3Ljc3OCAxMzQuNTEgMTk3LjY2MiAxMjYuNzIgMjI2LjczNUMxMjUuNDg2IDIzMS4zNCAxMjAuNzUyIDIzNC4wNzMgMTE2LjE0NyAyMzIuODM5TDYzLjUwNDEgMjE4LjczM0MyOS44MjY0IDIwOS43MSA5Ljg0MDk0IDE3NS4wOTIgMTguODY0OSAxNDEuNDE0TDg4LjE4MzYgMTU5Ljk4OFoiIGZpbGw9IiMyNDYyN0IiLz4KPHBhdGggZD0iTTE4Ni44NjcgMTcyLjk4QzE1Mi4wMDIgMTcyLjk4IDEyMy43MzcgMjAxLjI0NSAxMjMuNzM3IDIzNi4xMTFIMTg2Ljg3QzIyMS43MzYgMjM2LjExMSAyNTAgMjA3Ljg0NiAyNTAgMTcyLjk4TDE4Ni44NjcgMTcyLjk4WiIgZmlsbD0iIzMxNzQ4RiIvPgo8cGF0aCBkPSJNNjMuMTMyNyAxNzIuOThDOTcuOTk4NCAxNzIuOTggMTI2LjI2MyAyMDEuMjQ1IDEyNi4yNjMgMjM2LjExMUg2My4xM0MyOC4yNjQyIDIzNi4xMTEgLTEuNTI0MDNlLTA2IDIwNy44NDYgMCAxNzIuOThMNjMuMTMyNyAxNzIuOThaIiBmaWxsPSIjMzE3NDhGIi8+CjxwYXRoIGQ9Ik0xNzEuNzE3IDc1LjEyNjNDMTcxLjcxNyAxMDEuMjc2IDE1MC41MTggMTIyLjQ3NSAxMjQuMzY5IDEyMi40NzVDOTguMjE4OCAxMjIuNDc1IDc3LjAyMDIgMTAxLjI3NiA3Ny4wMjAyIDc1LjEyNjNDNzcuMDIwMiA0OC45NzY0IDk4LjIxODggMjcuNzc3OCAxMjQuMzY5IDI3Ljc3NzhDMTUwLjUxOCAyNy43Nzc4IDE3MS43MTcgNDguOTc2NCAxNzEuNzE3IDc1LjEyNjNaIiBmaWxsPSIjRUJCQ0JBIi8+CjxwYXRoIGQ9Ik0xNDQuMjE3IDg2LjIzNzlDMTYxLjY0OSA1Ni4wNDMyIDE1MS4zMDMgMTcuNDMyOSAxMjEuMTA4IDBMMTA2LjA2IDI2LjA2NDRDODguNjI3IDU2LjI1OSA5OC45NzM2IDk0Ljg2OTQgMTI5LjE2OCAxMTIuMzAyTDE0NC4yMTcgODYuMjM3OVoiIGZpbGw9IiNFQkJDQkEiLz4KPHBhdGggZD0iTTEyNS4yOTkgNjAuOTc4OUMxMTYuMjc1IDI3LjMwMTIgODEuNjU3NSA3LjMxNTY3IDQ3Ljk3OTcgMTYuMzM5Nkw2NC4zMTk3IDc3LjMyMTFDNzMuMzQzNiAxMTAuOTk5IDEwNy45NjEgMTMwLjk4NCAxNDEuNjM5IDEyMS45NkwxMjUuMjk5IDYwLjk3ODlaIiBmaWxsPSIjRUJCQ0JBIi8+CjxwYXRoIGQ9Ik0xMjQuOTI2IDYwLjk3ODlDMTMzLjk1IDI3LjMwMTIgMTY4LjU2NyA3LjMxNTY3IDIwMi4yNDUgMTYuMzM5NkwxODUuOTA1IDc3LjMyMTFDMTc2Ljg4MSAxMTAuOTk5IDE0Mi4yNjMgMTMwLjk4NCAxMDguNTg2IDEyMS45NkwxMjQuOTI2IDYwLjk3ODlaIiBmaWxsPSIjRUJCQ0JBIi8+Cjwvc3ZnPgo=&style=for-the-badge" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
## Usage
|
||||
|
||||
## Gallery
|
||||
|
||||
|
||||
|
||||
## Thanks to
|
||||
|
||||
- [punkfairie](https://git.punkfairie.net/punkfairie)
|
||||
|
||||
## Contributing
|
||||
|
||||
> Prefer using [@rose-pine/build](https://github.com/rose-pine/build) when possible
|
||||
|
||||
Modify `template.json` using Rosé Pine variables, then build variants:
|
||||
|
||||
```sh
|
||||
npx @rose-pine/build@latest
|
||||
```
|
||||
|
||||
## Style guide
|
||||
|
||||
> Be sure to remove this section 😌
|
||||
|
||||
- Lowercase meta files, eg. `readme.md`
|
||||
- Repo name should be the simplest version of the app name, eg. iterm instead of iTerm2
|
||||
- Add a description and topics to automatically show the theme on [rosepinetheme.com/themes](https://rosepinetheme.com/themes)
|
||||
- Description should read "Soho vibes for App" where "App" is the display name
|
||||
- Topics should include [existing categories](https://rosepinetheme.com/themes)
|
||||
- Generate and upload social image via [Rosé Pine Images](https://rose-pine-images.vercel.app)
|
||||
Loading…
Reference in a new issue