From 9538a61919cc654bc1d6adeaed7ff75dc49d7df8 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Sat, 19 Oct 2024 14:23:02 -0700 Subject: docs: move examples text into examples --- README.md | 12 ++---------- examples/README.md | 2 ++ 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, -- cgit v1.2.3