diff --git a/README.md b/README.md index a1b0d90..9e773dd 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,59 @@ # WIP SMC fonts flake -This is a WIP Flake that can install SMCs fonts. +This is a WIP Flake that can install SMCs fonts. Currently, the following are supported. + +1. Anjali Old Lipi +2. Chilanka +3. Manjari + +## Using with a flakes+home-manager based nixOS setup + +In the inputs section + +``` + inputs = { + nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; + + # Other flakes/modules/inputs + + smcFonts.url = "gitlab:smc/smc-fonts-flake/trunk"; + smcFonts.inputs.nixpkgs.follows = "nixpkgs"; + }; +``` + +In the outputs section of the flake: + +``` +# Note the smcFonts being passed as an argument + outputs = { self, nixpkgs, smcFonts, }@inputs: + let platforms = [ "x86_64-linux" ]; + in { + + nixosConfigurations = { + hex = nixpkgs.lib.nixosSystem { + system = "x86_64-linux"; + specialArgs = { inherit inputs; }; # <-- The inputs are being passed down to the modules + modules = [ + (import ./hosts/default.nix) + ]; + }; + + }; +} +``` + +Lastly, in `default.nix` + +``` +{ config, lib, pkgs, modulesPath, inputs, ... }: # <-- "inputs" is an argument +let + smc-fonts = inputs.smcFonts.packages."${pkgs.system}".default; # <-- by default, it will install all fonts +in +{ + + home-manager.users. = { pkgs, ...}: { + + home.packages = with pkgs; [ + # list of home manager packages + smc-fonts # what we defined above. +```