hiro/poetry2nix
1
0
Fork 0
mirror of https://github.com/vale981/poetry2nix synced 2025-03-04 16:51:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Adjust the README.md and provide a usage example

Browse source
This commit is contained in:
Eric Wolf 2020-11-22 09:37:38 +01:00
parent 4d83e7e3af
commit 1c7e2dfe29
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -207,6 +207,32 @@ in pkgs.poetry2nix.mkPoetryApplication {
}
```
## Using the flake
For the experimental flakes functionality we provide poetry2nix as a flake providing an overlay
to use with [nixpkgs](https://nixos.org/nixpkgs/manual).
#### Example
```nix
{
description = "Your flake using poetry2nix";
inputs.nixpkgs.url = "github:NixOS/nixpkgs";
inputs.utils.url = "github:numtide/flake-utils";
inputs.poetry2nix-src.url = "github:nix-community/poetry2nix";
outputs = {nixpkgs, utils, poetry2nix-src, self}: utils.lib.eachDefaultSystem (system: let
pkgs = import nixpkgs { inherit system; overlays = [ poetry2nix-src.overlay ]; };
in
{
# use pkgs.poetry2nix here.
});
}
```
## Contributing
Contributions to this project are welcome in the form of GitHub PRs. Please consider the following before creating PRs: