README.md

CatNerd

Previews

🌻 Latte

🪴 Frappé

🌺 Macchiato

🌿 Mocha

Modules List

The following is a list of supported and planned modules.

NixOS

• Console
• Font
• GTK
• GRUB
• KMScon
• Plymouth
• TTY
• SDDM

Home-Manager

• Alacritty
• Bat
• Btop
• CAVA
• Cursor
• Delta
• Dunst
• FCITX5
• Fish
• Foot
• Fzf
• GH-Dash
• GitUI
• Glamour
• GTK
• Helix
• Hyprland
• Hyprlock
• IMV
• K9s
• Kitty
• Kvantum
• LazyGit
• Mako
• Micro
• MPV
• NeoVim
• NewsBoat
• Polybar
• QT
• Rio
• Rofi
• Skim
• Starship
• Sway
• Swaylock
• Sway Notification Center
• Tmux
• Tofi
• Waybar
• WezTerm
• Xresources
• Yazi
• Zathura
• Zellij
• ZSH-Syntax-Highlighting

Usage

1. Include the input in your flake:

   inputs = {
       ...
       catnerd.url = "github:ElliottSullingeFarrall/catnerd";
       ...
   }

2. In your outputs include the NixOS and home-manager modules:

   outputs = { self, home-manager, catnerd, ... }: {
       nixosConfigurations.machine = lib.nixosSystem rec {
           ...
           modules = [
               home-manager.nixosModules.home-manager {
                   home-manager = {
                       ...
                       sharedModules = [ inputs.catnerd.homeManagerModules.catnerd ];
                       ...
                   };
               }
               inputs.catnerd.nixosModules.catnerd
           ];
           ...
   }

3. In both nixos and home-manager you can configure catnerd like

   catnerd = {
       enable = true;
   
       flavour = "macchiato";
       accent = "pink";
   
       cursor.size = 24;
   
       fonts = {
         main = {
           family = "Ubuntu";
           size = 10;
         };
         mono = {
           family = "DroidSansM";
           size = 14;
         };
       };
     };

To Do

Fonts

Use font data to auto-populate options.

Testing

Implement better testing methods that use all possible options combinations.