Skip to content

Commit

Permalink
docs: add information about nvfetcher
Browse files Browse the repository at this point in the history
  • Loading branch information
getchoo committed Jul 30, 2023
1 parent e906ca9 commit 69cb379
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,16 @@ Create a file in `modules/<module>/` with the name of the port. Add the file to
`catppuccin.enable` and `catppuccin.flavour` options, and optionally the
`catppuccin.accent` option. `catppuccin.flavour` and `catppuccin.accent` should
default to `config.catppuccin.flavour` and `config.catppuccin.accent`, respectively.
[Flake inputs](https://nixos.wiki/wiki/Flakes#Input_schema) should also be used over
`fetchFromGitHub` when themes are not avalible in nixpkgs - this in order to reduce
[IFD](https://nixos.wiki/wiki/Import_From_Derivation) and allow for auto-updating the
specified commits for repositories.

[nvfetcher](https://github.com/berberman/nvfetcher) is used to track our upstream
sources to use in modules. This allows us to reduce [IFD](https://nixos.wiki/wiki/Import_From_Derivation)
and auto-update all themes. Most repositories can be specified like so:

```toml
[program_name]
src.git = "https://github.com/catppuccin/program_name.git"
fetch.github = "catppuccin/program_name"
```

After creating your module, add the options to enable it in `test.nix` under the
`nodes.machine` attrset. This will allow for your configuration to be tested along
Expand Down

0 comments on commit 69cb379

Please sign in to comment.