git.iko.soy/typeable/stackage2nix
on master help sign in
Update README
7ff5d11Dmitry Bushev
README.md+29−7
compare with master
unifiedsplit
@@ -16,7 +16,34 @@ nix-env -i -f ./nix/stackage2nix
16It provides pre-configured wrapper around the raw executable with runtime
16It provides pre-configured wrapper around the raw executable with runtime
17`PATH` and all auxiliary flags set up.
17`PATH` and all auxiliary flags set up.
18
18
19−## Executable
19+## Build project
20+
21+Generate derivations from `stack.yaml` config using Nix wrapper:
22+
23+``` bash
24+stackage2nix ./stack.yaml
25+```
26+
27+if you're using the raw executable, you should supply additional flags. See
28+section 'Flags' below for details.
29+
30+This command will result in a Haskell packages set, similar to
31+`pkgs.haskell.packages.<compiler>`, containing only packages that are required
32+to build targets listed in `stackage.yaml`. To build a package run:
33+
34+``` bash
35+nix-build -A my-package
36+```
37+
38+## Build stackage
39+
40+Generate complete Stackage packages set from resolver:
41+
42+``` bash
43+stackage2nix --resolver lts-9.0
44+```
45+
46+## Flags
20
47
21```
48```
22stackage2nix \
49stackage2nix \
@@ -77,7 +104,7 @@ For more complex overrides and detailed information on how to work with Haskell
77
104
78## Tests
105## Tests
79
106
80−Integration tests that check generation of stackage packages versus different stack configs:
107+Integration tests that build stackage2nix form different stack configs:
81
108
82```
109```
83STACKAGE_REPO=<path/to/stackage/repo> \
110STACKAGE_REPO=<path/to/stackage/repo> \
@@ -85,8 +112,3 @@ ALL_CABAL_HASHES=<path/to/all-cabal-hashes/repo> \
85STACK_FILE=stack-ghc-7103.yaml \
112STACK_FILE=stack-ghc-7103.yaml \
86./ci-stackage2nix
113./ci-stackage2nix
87```
114```
88−
89−## Examples
90−
91−For other examples of `stackage2nix` usage, see [4e6/stackage2nix-examples](https://github.com/4e6/stackage2nix-examples) repository.
92−It verifies `stackage2nix` by running it on different public projects.