git.iko.soy/haskell.nix
on e94de40 help sign in
haskell.nix/README.md
39 lines 2.5 kB history raw
1# `haskell.nix` is infrastructure for building Haskell packages with Nix
3[![](https://badge.buildkite.com/d453edcd29bd2f8f3f3b32c9b7d6777a33773d9671c37a6ccc.svg?branch=master)](https://buildkite.com/input-output-hk/haskell-dot-nix)
4[![](https://img.shields.io/buildkite/c8d5a20d3ff0f440f82adb9190b43c16c91e5e47e8adfa867a/master.svg?label=nightly%20updates)](https://buildkite.com/input-output-hk/haskell-dot-nix-nightly-updates)
6`haskell.nix` can automatically translate your Cabal or Stack project and
7its dependencies into Nix code.
9## Documentation
11- [Introduction](https://input-output-hk.github.io/haskell.nix/)
12- [Getting Started](https://input-output-hk.github.io/haskell.nix/tutorials/getting-started/)
13- [Troubleshooting](https://input-output-hk.github.io/haskell.nix/troubleshooting/)
14- Explore the documentation from there to find further topics.
16## Help! Something isn't working
18The #1 problem that people have when using `haskell.nix` is that they find themselves building GHC.
19This should not happen, but you *must* follow the `haskell.nix` setup instructions properly to avoid it.
20If you find this happening to you, please check that you have followed the
21[getting started instructions](https://input-output-hk.github.io/haskell.nix/tutorials/getting-started/#setting-up-the-binary-cache) and
22consult the corresponding [troubleshooting section](https://input-output-hk.github.io/haskell.nix/troubleshooting/#why-am-i-building-ghc).
24The troubleshooting documentation also contains some help for other common issues.
25Please give it a read before asking on IRC or opening an issue.
27If you're still stuck, join the [#haskell.nix](https://www.irccloud.com/invite?channel=%23haskell.nix&hostname=irc.freenode.net&port=6697&ssl=1) channel on [irc.freenode.net](https://freenode.net/), or open an issue.
29## Related repos
31The `haskell.nix` repository contains the runtime system for building
32Haskell packages in Nix. It depends on other repos, which are:
34- [`nix-tools`](https://github.com/input-output-hk/nix-tools) — provides the programs for generating Nix expressions from Haskell projects.
36- [`hackage.nix`](https://github.com/input-output-hk/hackage.nix) — the latest contents of the [Hackage](https://hackage.haskell.org/) databases, converted to Nix expressions.
38- [`stackage.nix`](https://github.com/input-output-hk/stackage.nix) — all of the [Stackage](https://www.stackage.org/) snapshots, converted to Nix expressions.