summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
index 57ba3f4..7ad271d 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,33 @@
[![biz build status](https://builds.sr.ht/~ben/biz.svg)](https://builds.sr.ht/~ben/biz?)
+# Source layout
+
+ aero browser apps, compiled with ghcjs
+ apex server-side api stuff
+ chip executable scripts in python, bash
+ depo for deployment, machine-specific nix code, like networking.nix
+ lore shared code, libraries, general code
+ mode nixos modules; services and modular config
+ pack nix packages, like ibb/default.nix, & external packages that we import
+ soar s3/spaces assets, like images, via git-annex
+ Makefile instructions for building the artifacts
+ default.nix contains all the build stuff, combines everything, builds the entire system
+
+This isn't totally in place yet, but it's something to work toward.
+
+# Development
+
+To get a development shell, for example to work on ibb, you can do:
+
+ $ nix-shell pack/ibb.nix
+ $ ghci
+ GHCi, version 8.4.3: http://www.haskell.org/ghc/ :? for help
+ Loaded GHCi configuration from /home/ben/src/biz/.ghci
+ λ :load apex/Main.hs
+ [1 of 2] Compiling Influencers ( apex/Influencers.hs, interpreted )
+ [2 of 2] Compiling Main ( apex/Main.hs, interpreted )
+ Ok, two modules loaded.
+
# Deployment
To build the production server config locally: