Merge pull request #2 from iancleary/feat/update-readme

Update readme with examples

README.md

@@ -1,2 +1,111 @@
 # terminal-config
-Submodule to be used with Nix and Home-Manager with flakes
+
+Nix to be used with Nix and Home-Manager with flakes
+
+## Examples
+
+### Macos
+
+```flake.nix
+
+{
+  description = "Example Darwin system flake";
+
+  inputs = {
+    flake-utils.url = "github:numtide/flake-utils";
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-23.11";
+    nixpkgs-unstable.url = "github:NixOS/nixpkgs/nixos-unstable";
+    nix-darwin.url = "github:LnL7/nix-darwin";
+    nix-darwin.inputs.nixpkgs.follows = "nixpkgs";
+    home-manager.url = "github:nix-community/home-manager";
+    home-manager.inputs.nixpkgs.follows = "nixpkgs";
+    terminal-config.url = "github:iancleary/terminal-config";
+  };
+
+  outputs = inputs@{ self
+    , flake-utils
+    , nixpkgs
+    , nixpkgs-unstable
+    , nix-darwin
+    , home-manager
+    , terminal-config
+    }:
+  let
+    forAllSystems = nixpkgs.lib.genAttrs flake-utils.lib.defaultSystems;
+    overlays = {
+        unstable = final: prev: {
+          unstable = nixpkgs-unstable.legacyPackages.${prev.system};
+        };
+        neovimPlugins = terminal-config.overlays.default;
+    };
+
+    legacyPackages = forAllSystems (system:
+        import inputs.nixpkgs {
+            inherit system;
+            overlays = builtins.attrValues overlays;
+            config.allowUnfree = true;
+        }
+    );
+  in
+  {
+    # Build darwin flake using:
+    # $ darwin-rebuild build --flake .#eMacOS
+    darwinConfigurations."macbookAir" = nix-darwin.lib.darwinSystem {
+      pkgs = legacyPackages."aarch64-darwin";
+      system = "aarch64-darwin";
+      modules = [
+        ./modules/nix-darwin/default.nix # nix-darwin configuration
+
+        # home-manager configuration
+        home-manager.darwinModules.home-manager
+          {
+            home-manager.useGlobalPkgs = true;
+            home-manager.useUserPackages = true;
+            home-manager.users.iancleary = import ./modules/home-manager/default.nix;
+
+            # This (below) is required to pass the flake inputs to the modules,
+            # so the remote terminal-config flake can be used
+            home-manager.extraSpecialArgs = { inherit inputs self; }; # Passes the flake inputs to the modules
+            # Optionally, use home-manager.extraSpecialArgs to pass
+            # arguments to home.nix
+          }
+      ];
+      specialArgs = { inherit inputs self; }; # Passes the flake inputs to the modules
+    };
+
+    # Expose the package set, including overlays, for convenience.
+    darwinPackages = self.darwinConfigurations."macbookAir".pkgs;
+  };
+}
+```
+
+```modules/home-manager/default.nix
+{ inputs, lib, ... }:
+
+{
+  # Home Manager needs a bit of information about you and the
+  # paths it should manage.
+  home = rec {
+    username = "iancleary";
+    homeDirectory = lib.mkForce "/Users/${username}"; # lib.mkForce allows for user to already exist
+    stateVersion = lib.mkDefault "23.11";
+  };
+
+  # Let Home Manager install and manage itself.
+  programs.home-manager.enable = true;
+
+  # Rest of the configuration is in a separate folder.
+  imports = [
+    inputs.terminal-config.homeManagerModules.default
+  ];
+
+  myTerminal = {
+    neovim = {
+      enable = true;
+      enableLSP = true;
+    };
+    zsh.enable = true;
+  };
+
+}
+```