flake-compat/README.md
mei (ckie) 98797efd23
Change README.md instructions to be slightly more versatile.
Accept other forks also with type="github".

This is enough to be a bit more convenient in a few more
cases once this propagates into new future projects.
2023-01-01 23:47:37 +02:00

31 lines
674 B
Markdown

# flake-compat
## Usage
To use, add the following to your `flake.nix`:
```nix
inputs.flake-compat = {
url = "github:edolstra/flake-compat";
flake = false;
};
```
Afterwards, create a `default.nix` file containing the following:
```nix
(import
(
let lock = builtins.fromJSON (builtins.readFile ./flake.lock); in
fetchTarball {
url = with lock.nodes.flake-compat.locked;
"https://github.com/${owner}/${repo}/archive/${rev}.tar.gz";
sha256 = lock.nodes.flake-compat.locked.narHash;
}
)
{ src = ./.; }
).defaultNix
```
If you would like a `shell.nix` file, create one containing the above, replacing `defaultNix` with `shellNix`.