added some beginning docu

README.md

@@ -1,3 +1,13 @@
-# nixMail
+# nixConfig
 
-a try to configure a nixOS mail server
+## Build a machine
+### Local
+If you want to build the machineconfiguration for machine <name>
+run
+```
+nix build .#nixosConfiguration.<name>
+```
+
+### On the machine
+clone this repo to `/etc/nixos/` and `nixos-rebuild` that will select
+the appropriate machine based on hostname

flake-module.nix

@@ -1,6 +1,9 @@
 {inputs, ...}:
 {
-  debug = true;
+  # debug = true;
+  # We only define machines config in this flake yet, so we only include
+  # the module that builds these. This file might get fuller, if we need to
+  # build our own packages, that are not flakes.
   imports = [ ./nixos/flake-module.nix
         # To import a flake module
         # 1. Add foo to inputs

nixos/flake-module.nix

@@ -1,4 +1,7 @@
 # copied and adopted from maralorns config
+
+# This automatically searches for nixos configs in ./machines/${name}/configuration.nix
+# and exposes them as outputs.nixosConfigurations.${name}
 { withSystem, lib, inputs, ... }: {
   flake = {
     nixosConfigurations = withSystem "x86_64-linux" ({ pkgs, ... }: