🎉📝 initialize v2

README.md

@@ -1,15 +1,35 @@
-# Puzzlevision
+<br>
+<div align="center"><img src="assets/puzzlevision.png" width="120px" height="auto"></div>
 
-Non-stop entertainment! The wackiest NixOS configuration to-date.
+<h1 align="center">✨ Puzzlevision ✨<br></h1>
+<div align="center">Non-stop entertainment! The wackiest NixOS configuration to-date.</div>
+<br>
 
-## Deployment
+## 🚧 State of development
+Version 2.0 is still very much an experiment and not ready to be used in a production
+environment. If you must, try running it within a VM using the provided deployment
+instructions.
+
+## 🚀 Deployment
+To deploy a system run the following command in your terminal of choice.
 
-Run this to apply your system configuration.
 ```sh
 sudo nixos-rebuild switch --flake .#hostname
 ```
 
-Run this, to apply your home-manager configuration.
+If you're interested in a quick way to experiment with this configuration,
+you may use the following command to build a VM.
+
 ```sh
-home-manager switch --flake .#username@hostname
+sudo nixos-rebuild build-vm --flake .#hostname
 ```
+
+## 📝 Goals and improvements
+The main goals of this rewritten flake are:
+
+- using flake-parts in place of Snowfall lib
+- significantly improving the re-usability of all modules
+- avoiding anti-patterns, such as `with lib; with lib.${namespace};`
+- improved secrets management
+- keeping external assets closer to their related nix file, e.g. wallpapers in
+the desktop modules folder