on iko/ghcjs-patch-master help sign in
Add information about the binary cache to README.org (#300)

* Add information about the binary cache to README.org * Add binary cache section to the User Guide Put the subsection right above "Using Haskell.nix with your project" in the General section of the User Guide so new users are likely to see it.

commit6e95ba56f10634378236076575bef0a72e066a31 authorToon Nolten <toonn@toonn.io> dateThu 14 Nov 2019, 03:35 (7 years ago) parent34ed9da
2 files changed+17
README.org+9 docs/user-guide.md+8
README.org+9
@@ -59,6 +59,15 @@ cabal new-build your-package-name
5959cabal new-repl your-package-name:library:your-package-name
6060#+end_src
6161
62+** Cache
63+
64+CI pushes to [[https://cachix.org][cachix]] so you can benefit from the cache
65+if you pin a combination of =haskell.nix= and =nixpkgs= built by CI.
66+
67+You'll need to configure the [[nix-tools cachix][https://nix-tools.cachix.org]]
68+as a =substituter= for =nix= and add the public key found at the url to
69+=trusted-public-keys=.
70+
6271** Related repos
6372
6473The =haskell.nix= repository contains the runtime system for building
docs/user-guide.md+8
@@ -71,6 +71,14 @@ cd haskell.nix
7171nix build -f . haskell-nix.nix-tools --out-link nt
7272```
7373
74+## Setting up the Cachix binary cache
75+
76+CI pushes to [cachix](https://cachix.org) so you can benefit from the cache if
77+you pin a combination of `haskell.nix` and `nixpkgs` built by CI. You'll need
78+to configure the [nix-tools cachix](https://nix-tools.cachix.org) as a
79+`substituter` for `nix` and add the public key found at the url to
80+`trusted-public-keys`.
81+
7482## Using [Haskell.nix][] with your project
7583
7684The easiest way to get a hold of [Haskell.nix][] is with