diff --git a/Quick-Start.md b/Quick-Start.md new file mode 100644 index 0000000..1062543 --- /dev/null +++ b/Quick-Start.md @@ -0,0 +1,34 @@ +# Quick Start + +This page covers the minimum steps to use or administer an +Athenix-managed system. + +## End Users + +Update your system: + +```bash +update-system +``` + +If you use an external user configuration: + +```bash +sudo nixos-rebuild switch \ + --flake git+https://git.factory.uga.edu/UGA-Innovation-Factory/athenix.git \ + --impure +``` + +## Administrators + +Typical workflow: + +```bash +vim inventory.nix +nix flake check +nix fmt +git commit -am "Describe changes" +git push +``` + +Users receive updates via `update-system`.