Add a README.md containing copy & paste helpers

This commit is contained in:
Piper McCorkle 2021-12-30 17:50:53 -05:00 committed by GitHub
parent 12c64ca55c
commit b640d1826b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

29
README.md Normal file
View file

@ -0,0 +1,29 @@
# 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 = "https://github.com/edolstra/flake-compat/archive/${lock.nodes.flake-compat.locked.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`.