mayday/quintessence
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
morganmayday 2026-02-12 16:10:10 -08:00
parent 80a2e26cbd
commit 0a5a0563c7
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -9,14 +9,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. 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 ### ## feature list
- stable-repo based, with a module for unstable packages. - stable-repo based, with a module for unstable packages.
- easy environment variable management, from `flake.nix` and `modules/vars.nix`. - easy environment variable management, from `flake.nix` and `modules/vars.nix`.
- rebuild script and remote sync script. - rebuild script and remote sync script.
- fairly thorough comments throughout. - fairly thorough comments throughout.
## \### getting started ### ## 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. 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.
@ -43,9 +43,9 @@ 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. if that goes through with no problems, perfect! reboot, and you should be into the system.
## \### going from here ### ## 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! NixOS is *really easy to break,* but it's also *really 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! even that can be fixed with some hoops, a live installer, and a remote version of your dotfiles.
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. 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.