First edit of readme

This commit is contained in:
morganmayday 2026-02-12 15:28:13 -08:00
parent 15cb534ef7
commit 137cc44d43
2 changed files with 25 additions and 1 deletions

24
README.md Normal file
View file

@ -0,0 +1,24 @@
#################################################################
# .▄▄▄ ▄• ▄▌▪ ▐ ▄ ▄▄▄▄▄▄▄▄ ..▄▄ · .▄▄ · ▄▄▄ . ▐ ▄ ▄▄· ▄▄▄ . #
# ▐▀•▀█ █▪██▌██ •█▌▐█•██ ▀▄.▀·▐█ ▀. ▐█ ▀. ▀▄.▀·•█▌▐█▐█ ▌▪▀▄.▀· #
# █▌·.█▌█▌▐█▌▐█·▐█▐▐▌ ▐█.▪▐▀▀▪▄▄▀▀▀█▄▄▀▀▀█▄▐▀▀▪▄▐█▐▐▌██ ▄▄▐▀▀▪▄ #
# ▐█▪▄█·▐█▄█▌▐█▌██▐█▌ ▐█▌·▐█▄▄▌▐█▄▪▐█▐█▄▪▐█▐█▄▄▌██▐█▌▐███▌▐█▄▄▌ #
# ·▀▀█. ▀▀▀ ▀▀▀▀▀ █▪ ▀▀▀ ▀▀▀ ▀▀▀▀ ▀▀▀▀ ▀▀▀ ▀▀ █▪·▀▀▀ ▀▀▀ #
#################################################################
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`.
in a text editor of your choice, make some changes to the provided files.
-- in `flake.nix`, change the variables section as instructed.
-- if you set up disk encryption, copy your `boot.initrd.luks.devices` line from `/etc/nixos/configuration.nix` to `/home/USERNAME-GOES-HERE/dotfiles/configuration.nix`.

View file

@ -1,5 +1,5 @@
{
description = "Barebones version of Morgan Mayday's v1.0b config, for newer users";
description = "quintessence, a nixos config for newer users, with KDE Plasma";
inputs = {
nixos-hardware.url = "github:NixOS/nixos-hardware/master";