From 310ab70d9e690b641005ceafc6582305195c8711 Mon Sep 17 00:00:00 2001 From: seth Date: Thu, 11 Jan 2024 17:03:38 -0500 Subject: [PATCH] docs: cleanup CONTRIBUTING.md --- CONTRIBUTING.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a2be1cf0..a0590ba4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,15 +2,14 @@ ## Adding a port -Create a file in `modules//` with the name of the port. Add the file to the -`imports` declaration in `modules//default.nix`. All ports should have the -`catppuccin.enable` and `catppuccin.flavour` options, and optionally the +Create a file in `modules//` with the name of the port. All ports should have +the `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. [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: +sources to use in modules. This allows us to easily access and auto-update all themes. +Most repositories can be specified like so: ```toml [program_name] @@ -22,7 +21,7 @@ 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 with the other modules in a VM automatically. - + Commits that add ports should be of the format ```