Rework README about nixos-infect HOT 6 CLOSED

Are there any thoughts on this? Or should I just go ahead and open the PR?

from nixos-infect.

If it reduces the number of lines in the script, I am probably for it. I'd like for the entire script to be self-documenting, but asking users to read more than the first 10 lines of the comment header is unrealistic, I think, so everything must be succinct.

from nixos-infect.

I agree that the script itself should be self-contained and descriptive. However, this is discussing the README, which shouldn't have an effect on the script itself I dont think.

from nixos-infect.

Anything can go in README; I just don't think 90% of users will ever see it, since they curl the main script and don't bother installing git to clone the repo onto a doomed system. Maybe I'm way off with my estimate.

from nixos-infect.

Repeat users may not. First time users should get a bit of of a gentler introduction to what's going on, I think.

For instance, I got caught by the need for an authorized key for the root user the first time I ran through.

Its obvious now, but without a password defined in my nix configuration and no ssh key, I was locked out and needed to reprovision and start again. A note in the readme would've helped here.

Further, there's not much clarity on what the script does for non-digital ocean hosts without reading the script fully. Both other hosters aren't special - they are just default runs of the script with small differences to the log treatment.

I'll work this PR up in the morning and we can discuss specifics rather than these generalities.

from nixos-infect.

Closed via #67

from nixos-infect.