example: Always use local mission-control

Platonic-Systems · Dec 17, 2022 · 3b1c773 · 3b1c773
1 parent 9c466a7
commit 3b1c773
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,11 @@ A `flake-parts` module for your Nix devshell scripts
 
 ## Example
 
-See the [example](./example) directory for a working example. Run `nix develop` (or `direnv allow`) to drop into the Nix shell, which will display the mission control banner as shown below:
+See the [example](./example) directory for a working example.
+
+Run `nix develop --override-input mission-control path:../.`[^override] (or simply `direnv allow` if you already use direnv) to drop into the Nix shell, which will display the mission control banner as shown below:
+
+[^override]: The `--override-input` option is to be used when running from this repository to make sure that we are using the local version of `mission-control`. If you are copying this `flake.nix` to your project (without also copying the outdated `flake.lock`), you can simply run `nix develop`.
 
 ```
 ### ️🔨 Welcome to the Nix devshell ###

diff --git a/example/.envrc b/example/.envrc
@@ -1 +1 @@
-use flake
+use flake --override-input mission-control path:../.
diff --git a/example/flake.lock b/example/flake.lock