From dab091a7b776c66541238db6805022fcf4432406 Mon Sep 17 00:00:00 2001
From: Skyler Grey <skyler3665@gmail.com>
Date: Wed, 19 Oct 2022 23:40:49 +0100
Subject: [PATCH] Update NIX.md so it has more methods + is clearer

- Add proper headings
- Change flake codeblocks so that configuration stuff isn't in the same
  place as flake.nix stuff
- Add instructions for not using the overlay with flakes
- Add instructions for running ad-hoc with flakes

Signed-off-by: Skyler Grey <skyler3665@gmail.com>
---
 nix/NIX.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 56 insertions(+), 9 deletions(-)

diff --git a/nix/NIX.md b/nix/NIX.md
index e57d5be7..980d20e8 100644
--- a/nix/NIX.md
+++ b/nix/NIX.md
@@ -1,21 +1,59 @@
-# How to import
+# Running on Nix
 
-To import with flakes use
+## Putting it in your system configuration
+
+### On flakes-enabled nix
+
+#### Directly installing
+
+The `prismlauncher` flake provides a package which you can install along with
+the rest of your packages
 
 ```nix
+# In your flake.nix:
 {
   inputs = {
     prismlauncher.url = "github:PrismLauncher/PrismLauncher";
   };
-
-...
-
-  nixpkgs.overlays = [ inputs.prismlauncher.overlay ]; ## Within configuration.nix
-  environment.systemPackages = with pkgs; [ prismlauncher ]; ##
 }
 ```
 
-To import without flakes use channels:
+```nix
+# And in your system configuration:
+environment.systemPackages = [ prismlauncher.packages.${pkgs.system}.prismlauncher ];
+
+# Or in your home-manager configuration:
+home.packages = [ prismlauncher.packages.${pkgs.system}.prismlauncher ];
+```
+
+#### Using the overlay
+
+Alternatively, you can overlay the prismlauncher version in nixpkgs which will
+allow you to install using `pkgs` as you normally would while also using the
+latest version
+
+```nix
+# In your flake.nix:
+{
+  inputs = {
+    prismlauncher.url = "github:PrismLauncher/PrismLauncher";
+  };
+}
+```
+
+```nix
+# And in your system configuration:
+nixpkgs.overlays = [ inputs.prismlauncher.overlay ];
+environment.systemPackages = [ pkgs.prismlauncher ];
+
+# Or in your home-manager configuration:
+config.nixpkgs.overlays = [ inputs.prismlauncher.overlay ];
+home.packages = [ pkgs.prismlauncher ];
+```
+
+### Without flakes-enabled nix
+
+#### Using channels
 
 ```sh
 nix-channel --add https://github.com/PrismLauncher/PrismLauncher/archive/master.tar.gz prismlauncher
@@ -23,9 +61,10 @@ nix-channel --update prismlauncher
 nix-env -iA prismlauncher
 ```
 
-or alternatively you can use
+#### Using the overlay
 
 ```nix
+# In your configuration.nix:
 {
   nixpkgs.overlays = [
     (import (builtins.fetchTarball "https://github.com/PrismLauncher/PrismLauncher/archive/develop.tar.gz")).overlay
@@ -34,3 +73,11 @@ or alternatively you can use
   environment.systemPackages = with pkgs; [ prismlauncher ];
 }
 ```
+
+## Running ad-hoc
+
+If you're on a flakes-enabled nix you can run the launcher in one-line
+
+```sh
+nix run github:PrismLauncher/PrismLauncher
+```