aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2024-10-19 14:23:02 -0700
committerFuwn <[email protected]>2024-10-19 14:23:02 -0700
commit9538a61919cc654bc1d6adeaed7ff75dc49d7df8 (patch)
treed463fdc006ee6fc4096335fb94d9f223b671d578
parente0f5cf0118232644dfa28446cc289962573d920a (diff)
downloadyae-9538a61919cc654bc1d6adeaed7ff75dc49d7df8.tar.xz
yae-9538a61919cc654bc1d6adeaed7ff75dc49d7df8.zip
docs: move examples text into examples
-rw-r--r--README.md12
-rw-r--r--examples/README.md2
2 files changed, 4 insertions, 10 deletions
diff --git a/README.md b/README.md
index 47ff7aa..98f46da 100644
--- a/README.md
+++ b/README.md
@@ -130,16 +130,8 @@ from the Yae environment file. See the example below for more details.
### Examples
-Check out [`examples/nixpkgs`](./examples/nixpkgs) for a pure Nix example of Yae
-in action. This example is a little large since it constrains itself to **zero**
-inputs and manually constructs multi-system support. In a real-world scenario,
-you'd actually use something like [flake-utils](https://github.com/numtide/flake-utils)
-to replace all of the boilerplate. For this reason, [`examples/nixpkgs-simple`](./examples/nixpkgs-simple)
-exists, which functions identically, but uses `builtins.currentSystem` to
-populate the `nixpkgs.system` attribute. (requires `--impure`)
-
-If Nixpkgs ever goes out of date in these theorectical examples, just run
-`yae update`!
+Check out the [`examples/`](./examples) directory for a couple of great examples
+of Yae managing different sources including Nixpkgs!
#### Real-world Example
diff --git a/examples/README.md b/examples/README.md
index c70edc6..513f3b0 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -1,5 +1,7 @@
# Examples
+If Nixpkgs ever goes out of date in these examples, just run `yae update`!
+
## [Nixpkgs](https://github.com/Fuwn/yae/tree/main/examples/nixpkgs)
This example showcases adding the Nixpkgs unstable branch as a Yae source,