aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5dd3e0f..26395fb 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,16 @@
This repository is the starting point for storing all relevant NixOS configurations.
+## Layout
+
+This repository currently contains two systems I've configured similarly to track the current unstable NixOS branch, but with one system being a more home focused package set versus the other designed for work.
+
+By building on the modularity of this repository, it should be possible to capture any number of various combinations of system and user configurations from one or more people. I think everything is mostly laid out in such a way to support doing this very easily.
+
+This also means that as people come up with potentially new combinations of things, other people might be able to also benefit from them. I think that's sort of part of the charm that Nix in general provides.
+
+The section that follows is about a VM configured more for work and can be thought of as a template or starting point to define your own host, mostly with the same packages potentially, and with whatever personal touches you want for your own standard user account.
+
## richese
This host is currently assumed to be a VirtualBox VM. The VirtualBox VM should be configured with the following:
@@ -46,3 +56,9 @@ nix-master/scripts/install-with-disko richese
```
which should walk you through the rest of the installation.
+
+### Post-installation maintenance
+
+As part of the installation, the Git repo you grabbed above to perform the installation was also copied to /etc/nixos on your new system. Keeping a NixOS system up to date means keeping your living system configuration up to date also.
+
+To make this task slightly easier if this is your first NixOS installation, you can run the script `/etc/nixos/scripts/pretty-rebuild` as root which will perform a standard nixos-rebuild command to upgrade the system along with some informational output after that command finishes on what may have changed.