From 7d9ef4cb215edf8beb47af55ae62b37eac7cda7e Mon Sep 17 00:00:00 2001 From: punkfairie Date: Sat, 19 Oct 2024 17:12:35 -0700 Subject: [PATCH] feat: Switch to Rose Pine readme --- README.md | 215 ------------------------------------------------------ readme.md | 43 +++++++++++ 2 files changed, 43 insertions(+), 215 deletions(-) delete mode 100644 README.md create mode 100644 readme.md diff --git a/README.md b/README.md deleted file mode 100644 index c478a94..0000000 --- a/README.md +++ /dev/null @@ -1,215 +0,0 @@ -

- Logo
- - Catppuccin for Nix - -

- -

- - - -

- -

- -

- -## Previews - -
- 🌻 Latte - -
-
- 🪴 Frappé - -
-
- 🌺 Macchiato - -
-
- 🌿 Mocha - -
- -## 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 - -
-With Flakes - -```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 - ]; - }; - }; -} -``` - -
- -
-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 = [ - - # if you use home-manager - - ]; - - # if you use home-manager - home-manager.users.pepperjack = { - imports = [ - - ]; - }; -} - -``` - -For [standalone installations](https://nix-community.github.io/home-manager/index.html#sec-install-standalone) - -```nix -{ - imports = [ - - ]; - - home.username = "pepperjack"; - programs.home-manager.enable = true; -} -``` - -
- -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). - -
- Disable modules that use IFD - - ```nix - { - programs = { - cava.catppuccin.enable = false; - gh-dash.catppuccin.enable = false; - imv.catppuccin.enable = false; - swaylock.catppuccin.enable = false; - }; - - services = { - mako.catppuccin.enable = false; - }; - } - ``` -
- -## 💝 Thanks to - -- [Stonks3141](https://github.com/Stonks3141) -- [getchoo](https://github.com/getchoo) - -  - -

- -

- -

- Copyright © 2023-present Catppuccin Org -

- -

- -

diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..fa51eb6 --- /dev/null +++ b/readme.md @@ -0,0 +1,43 @@ +

+ +

Rosé Pine for Nix

+

+ +

All natural pine, faux fur and a bit of soho vibes for the classy minimalist

+ +

+ + + +

+ +## Usage + +## Gallery + +![Rosé Pine with App](https://user-images.githubusercontent.com/1474821/166155319-06796439-95a7-4aea-910e-927c1f24518e.png) + +## 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)