doc: new mdbook documentation

doc/start/from-nixos.md

@@ -0,0 +1,47 @@
+# From NixOS
+
+## Generate Configuration
+Assuming your happy with your existing partition layout, you can generate a
+basic NixOS configuration for your system using:
+```sh
+flk up
+```
+
+This will make a new file `hosts/up-$(hostname).nix`, which you can edit to
+your liking.
+
+Make sure your `i18n.defaultLocale` and `time.timeZone` are set properly for
+your region. Keep in mind that `networking.hostName` with be automatically
+set to the filename of your hosts file, so `hosts/my-host.nix` will have the
+hostname `my-host`.
+
+Now might be a good time to read the docs on [suites](../../suites) and
+[profiles](../../profiles) and add or create any that you need.
+
+> ##### _Note:_
+> While the `up` sub-command is provided as a convenience to quickly set up and
+> install a "fresh" NixOS system on current hardware, committing these files is
+> discouraged.
+>
+> They are placed in the git staging area automatically because they would be
+> invisible to the flake otherwise, but it is best to move what you need from
+> them directly into a host module of your own making, and commit that instead.
+# Installation
+
+Once your ready to deploy `hosts/my-host.nix`:
+```sh
+flk my-host switch
+```
+
+
+This calls `nixos-rebuild` with sudo to build and install your configuration.
+
+> ##### _Notes:_
+> - Instead of `switch`, you can pass `build`, `test`, `boot`, etc just as with
+>   `nixos-rebuild`.
+>
+> - It is convenient to have the template living at `/etc/nixos` so you can
+>   simply `sudo nixos-rebuild switch` from anywhere on the system, but it is
+>   not required.
+
+

doc/start/index.md

@@ -0,0 +1,38 @@
+# Quick Start
+The only dependency is nix, so make sure you have it [installed][install-nix].
+
+## Get the Template
+Here is a snippet that will get you the template without the git history:
+```sh
+nix-shell https://github.com/nrdxp/nixflk/archive/core.tar.gz -A shell \
+  --run "flk get core"
+
+cd flk
+
+nix-shell
+
+git init
+git add .
+git commit -m init
+
+cachix use nrdxp
+```
+
+This will place you in a new folder named `flk` with git initialized, and a
+nix-shell that provides all the dependencies, including the unstable nix
+version required.
+
+In addition, the [binary cache](../../cachix) is added for faster deployment.
+
+> ##### _Notes:_
+> - You can change `core` to [`community`](../introduction.md#community-profiles)
+>   in the call to `flk get`
+> - Flakes ignore files that have not been added to git, so be sure to stage new
+>   files before building the system.
+
+## Next Steps:
+- [Make installable ISO](./iso.md)
+- [Already on NixOS](./from-nixos.md)
+
+
+[install-nix]: https://nixos.org/manual/nix/stable/#sect-multi-user-installation

doc/start/iso.md

@@ -0,0 +1,11 @@
+# ISO
+
+Making and writing an installable iso for `hosts/NixOS.nix` is as simple as:
+```sh
+flk iso NixOS
+
+dd bs=4M if=result/iso/*.iso of=/dev/$your_installation_device \
+  status=progress oflag=sync
+```
+
+This works for any file matching `hosts/*.nix` excluding `default.nix`.