README: Improvements

Author: nh2

Diff for: README.md

@@ -3,23 +3,25 @@
 With this repository you can easily build most Haskell programs into fully static Linux executables.
 
 * results are fully static executables (`ldd` says `not a dynamic executable`)
-* to make that possible, it and all dependencies (including ghc) are built against [`musl`](https://www.musl-libc.org/) instead of glibc
+* to make that possible, each exe and all dependencies (including ghc) are built against [`musl`](https://www.musl-libc.org/) instead of glibc
 
 ## History
 
 `glibc` encourages dynamic linking to the extent that correct functionality under static linking is somewhere between difficult and bug-ridden.
 For this reason, static linking, despite its many advantages (details [here](https://github.com/NixOS/nixpkgs/issues/43795)) has become less and less common.
 
-Due to GHC's dependency on a libc, and many libraries depending on C libraries for which Linux distributions often do not include static library archive files, this situation has resulted in Haskell programs being extremely hard to produce for the common Haskeller, even though the language is generally well-suited for static linking.
+Due to GHC's dependency on a libc, and many libraries depending on C libraries for which Linux distributions often do not include static library archive files, this situation has resulted in fully static Haskell programs being extremely hard to produce for the common Haskeller, even though the language is generally well-suited for static linking.
 
-This project set out to solve this.
+This project solves this.
 
 It was inspired by a [blog post by Vaibhav Sagar](https://vaibhavsagar.com/blog/2018/01/03/static-haskell-nix/),
 and a [comment by Will Dietz](https://github.com/NixOS/nixpkgs/pull/37598#issuecomment-375117019) about musl.
 
+Work on this so far was sponsored largely by my free time, [FP Complete](https://haskell.fpcomplete.com/) and their clients, and the contributors mentioned [here](https://github.com/NixOS/nixpkgs/issues/43795#issue-342546855).
+
 By now we have a nixpkgs issue on [Fully static Haskell executables](https://github.com/NixOS/nixpkgs/issues/43795) (progress on which is currently this repo, with plans to later merge it into nixpkgs), and [a merged nixpkgs overlay for static nixpkgs in general](https://github.com/NixOS/nixpkgs/pull/48803).
 
-## Building a minimal example
+## Building a minimal example (don't use this in practice)
 
 `default.nix` builds an example executable (originally from https://github.com/vaibhavsagar/experiments). Run:
 
@@ -30,7 +32,7 @@ NIX_PATH=nixpkgs=nixpkgs nix-build --no-link
 This prints a path that contains the fully linked static executable in the `bin` subdirectory.
 
 This example is so that you get the general idea.
-In practice, you probably want to use the approach in the "Building arbitrary packages" section below.
+In practice, you probably want to use one of the approaches from the "Building arbitrary packages" or "Building stack projects" sections below.
 
 ## Binary caches for faster building (optional)
 
@@ -49,8 +51,6 @@ Note that you may not get cached results if you use a different `nix` version th
 
 ## Building arbitrary packages
 
-The [`static-stack`](./static-stack) directory shows how to build a fully static `stack` executable (a Haskell package with many dependencies), and makes it reasonably easy to build other packages as well.
-
 The [`survey`](./survey) directory maintains a select set of Haskell executables that are known and not known to work with this approach; contributions are welcome to grow the set of working executables.
 Run for example:
 
@@ -63,3 +63,13 @@ There are multiple package sets available in the survey (select via `-A`):
 * `working` -- build all exes known to be working
 * `notWorking` -- build all exes known to be not working (help welcome to make them work)
 * `haskellPackages.somePackage` -- build a specific package from our overridden package set
+
+If you are a nix user, you can easily `import` this functionality and add an override to add your own packages.
+
+## Building `stack` projects
+
+The [`static-stack2nix-builder-example`](./static-stack2nix-builder-example) directory shows how to build any `stack`-based project statically.
+
+Another example of this is the the official static build of `stack` itself.
+See the [`static-stack`](./static-stack) directory for how that's done.
+`stack` is a big package with many dependencies, demonstrating that this works also for large projects.

Diff for: static-stack2nix-builder-example/README.md

@@ -4,6 +4,6 @@ Example stack-based project that shows how to use `static-stack2nix-builder`.
 
 ## Usage in your project
 
-Copy the `default.nix` into your project, and adjust it as needed.
+Copy the [`default.nix`](./default.nix) into your project, and adjust it as needed.
 
 It has instructions for running inside.