From fa681367b39ef399468a04bbc36a4a8068b934b5 Mon Sep 17 00:00:00 2001 From: Santiago Fraire Date: Thu, 15 Jun 2023 22:26:45 +0200 Subject: [PATCH] docs(README): add examples and projects --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 98c67f6..e0fcebc 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,12 @@ _Core of a distributed framework for writing Nix Flakes._ -`flake-parts` provides the options that represent standard flake attributes +`flake-parts` provides the options that represent standard flake attributes and establishes a way of working with `system`. Opinionated features are provided by an ecosystem of modules that you can import. `flake-parts` _itself_ has the goal to be a minimal mirror of the Nix flake schema. -Used by itself, it is very lightweight. +Used by itself, it is very lightweight. # Why Modules? @@ -71,10 +71,22 @@ then slide `mkFlake` between your outputs function head and body, Now you can add the remaining module attributes like in the [the template](./template/default/flake.nix). -# Example +# Templates See [the template](./template/default/flake.nix). +# Examples + +See the folder [examples/](./examples). + +# Projects using flake-parts + +- [nixd](https://github.com/nix-community/nixd/blob/main/flake.nix) (c++) +- [hyperswitch](https://github.com/juspay/hyperswitch/blob/main/flake.nix) (rust) +- [argo-workflows](https://github.com/argoproj/argo-workflows/blob/master/dev/nix/flake.nix) (go) +- [nlp-service](https://github.com/recap-utr/nlp-service/blob/main/flake.nix) (python) +- [emanote](https://github.com/srid/emanote/blob/master/flake.nix) (haskell) + # Options Reference See [flake.parts options](https://flake.parts/options/flake-parts.html)