Skip to content

Commit

Permalink
doc: Add install instructions using lib.mkSubDerivation
Browse files Browse the repository at this point in the history
  • Loading branch information
juanibiapina committed Jun 20, 2024
1 parent c659e82 commit 63b4b86
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ brew install juanibiapina/tap/sub
</details>

<details>
<summary>Nix with Flakes (binary install)</summary>
<summary>Nix with Flakes (install the `sub` binary)</summary>

Add sub to your flake inputs:

Expand Down Expand Up @@ -64,6 +64,18 @@ Then add it to your packages:
```
</details>

<details>
<summary>Nix with Flakes (including setup)</summary>

This repository is a flake that exports a function
`lib.${system}.mkSubDerivation`. This function creates a package for your cli
that uses `sub` as the entry point and already includes the [Setup](#setup).

For an example on how to use it, check out https://github.com/ggazzi/dev-cli-utils

Thanks @ggazzi for writing this module.
</details>

## Setup

This section explains how to set up a CLI called `hat` using `sub`.
Expand Down

0 comments on commit 63b4b86

Please sign in to comment.