Skip to content

Commit

Permalink
docs(README): add examples and projects
Browse files Browse the repository at this point in the history
  • Loading branch information
woile committed Jun 22, 2023
1 parent a530cce commit fa68136
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit fa68136

Please sign in to comment.