Add a README

[nix-env-apps] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..26a7499
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# nix-env-apps
+
+A simple GUI to make managing declarative nix-env easier
+
+It has two buttons: "Edit Configuration" and "Apply Configuration"
+
+The "Edit Configuration" button launches an editor on
+`~/.config/nixpkgs/overlays/userPackages.nix`, creating it with a
+useful template if it doesn't exist.  All you have to do is put the
+applications you want installed between the [ ] brackets.  For example,
+to add Firefox and LibreOffice, you'd type `firefox` and `libreoffice`
+where shown here:
+
+    final: prev: {
+      userPackages = final.buildEnv {
+        name = "userPackages";
+        paths = (with final; [
+
+          firefox
+          libreoffice
+
+        ];
+      };
+    }
+
+Remember to save before pressing "Apply Configuration"!
+
+The "Apply Configuration" button runs `nix-env -riA nixos.userPackages`,
+which makes your changes take effect.  Note that this **removes** any
+other packages that you may have installed imperatively with `nix-env -i`.
+Prefer declarative installation by listing everything you want installed
+in the "Edit Configuration" configuration file!