summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBen Sima <ben@bsima.me>2019-03-02 16:54:23 -0800
committerBen Sima <ben@bsima.me>2019-03-02 16:54:23 -0800
commit3d0df3ed30014f22574af4b390553930ef7cbb7f (patch)
treefd72c076d495d10b5f12e72934953478c8f758f8 /README.md
parent189ae4dd8845ebd0967578accd03a77071ab2732 (diff)
Flesh out build topology
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index 4bcc314..ab47227 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,7 @@ This isn't totally in place yet, but it's something to work toward.
To get a development shell, for example to work on ibb, you can do:
- $ nix-shell pack --attr ibb
+ $ nix-shell -A pack.ibb
$ ghci
GHCi, version 8.4.4: http://www.haskell.org/ghc/ :? for help
Loaded GHCi configuration from /home/ben/src/biz/.ghci
@@ -27,7 +27,14 @@ To get a development shell, for example to work on ibb, you can do:
[2 of 2] Compiling Ibb ( apex/Ibb.hs, interpreted )
Ok, two modules loaded.
-Goals of the developer workflow:
+The build system topology is defined in `./default.nix`, so follow the import
+paths there to see what's available for building and installing locally. For
+example, to build `ibb`: `nix-build -A pack.ibb`. Or, to build the main app
+server with all dependencies and configuration: `nix-build -A
+depo.nutin-madaj.system`. Omitting `.system` will also build a VM that you can
+run locally for testing.
+
+## Goals of the developer workflow:
- have minimal ceremony
- default to asynchrony, but allow for synchronous work when necessary