update readme

This commit is contained in:
morganmayday 2026-02-12 16:08:02 -08:00
parent 0b694d43e4
commit 8cb5a9de2e

View file

@ -10,12 +10,14 @@
hello there, stranger! quintessence is an opinionated flake-based config, built from the ground up for newer users, using KDE Plasma as desktop manager.
`### feature list ###`
- stable-repo based, with a module for unstable packages.
- easy environment variable management, from `flake.nix` and `modules/vars.nix`.
- rebuild script and remote sync script.
- fairly thorough comments throughout.
`### getting started ###`
begin with the NixOS graphical install medium. make sure to set the hostname and username as you'll want them, then reboot into that system.
open up `/etc/nixos/configuration.nix` in a text editor of your choice, then add `programs.git.enable = true;` right below the `time.timeZone` line. save out, then run `nixos-rebuild switch`.
@ -42,6 +44,7 @@ sudo nixos-rebuild switch --impure --flake /home/$USERNAME/dotfiles
if that goes through with no problems, perfect! reboot, and you should be into the system.
`### going from here ###`
NixOS is *really easy to break,* but it's also pretty easy to fix. my first recommendation is to set up a remote repository, either on a good git server or github. if you do that, the `sync-dotfiles` provided script will be usable, and so will `rebuild p` to rebuild and push to remote. the only break i've come across that isn't quickly fixable with a rollback is changing your username or hostname--be very wary of doing that!
due to the setup, you should be able to just straight up run `rebuild` in your terminal to rebuild your system. the script it's referencing is in `dotfiles/scripts`, if you want to see. it takes the potential arguments `upr`, with `u` updating the system, `p` syncing with your remote, and `r` rebooting the second the rebuild is finished.