@@ -2,7 +2,8 @@
22
33[](https://travis-ci.org/4e6/stack2nix)
44
5−`stack2nix` converts a single Stack file into a Nix build expression.
5+`stack2nix` converts a Stack file into a Nix Haskell packages set.
6+It creates LTS Stackage packages set, and applies appropriate overrides on top of it.
67
78```
89stack2nix \
@@ -13,13 +14,13 @@ stack2nix \
1314
1415`stack2nix` has three required arguments:
1516- `--lts-haskell` - path to [fpco/lts-haskell](https://github.com/fpco/lts-haskell)
16−- `--all-cabal-hashes` - path to [commercialhaskell/all-cabal-hashes](https://github.com/commercialhaskell/all-cabal-hashes)
17+- `--all-cabal-hashes` - path to [commercialhaskell/all-cabal-hashes](https://github.com/commercialhaskell/all-cabal-hashes) checked out to `hackage` branch
1718- `.` - path to stack.yaml file or directory
1819
1920Produced Nix derivation split on following files:
20−- packages.nix - Stackage packages set
21−- configuration-packages.nix - compiler configuration
22−- default.nix - Haskell packages set
21+- packages.nix - Base Stackage packages set
22+- configuration-packages.nix - Compiler configuration
23+- default.nix - Final Haskell packages set with all overrides applied
2324
2425A particular package from result Haskell packages set can be built with:
2526
@@ -47,11 +48,10 @@ in haskellPackages.override {
4748nix-build -A stack2nix override.nix
4849```
4950
50−`stack2nix` result derivation is a Haskell packages set, constructed the same way as a default Nix `haskellPackages`.
51−For further details and examples on how to work with Haskell packages in Nix, see Nixpkgs manual [User’s Guide to the Haskell Infrastructure](http://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure)
51+For more complex overrides and detailed information on how to work with Haskell packages in Nix, see Nixpkgs manual [User’s Guide to the Haskell Infrastructure](http://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure)
5252
5353
5454## Examples
5555
5656For other examples of `stack2nix` usage, see [4e6/stack2nix-examples](https://github.com/4e6/stack2nix-examples) repository.
57−It checks `stack2nix` execution against different public projects.
57+It verifies `stack2nix` by running it on different public projects.