summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Sima <ben@bsima.me>2020-07-26 10:13:56 -0700
committerBen Sima <ben@bsima.me>2020-07-26 10:13:56 -0700
commita3b0d69cc23a5f53cd48d82655b5247c1884eb51 (patch)
tree063f0fa8913bcf9b2ab8ec1e3053e349c7bb2573
parent01bda0f0aa87c34a30253ffd1d5b60b33644f6d8 (diff)
reorganize readme
-rw-r--r--Biz.md25
-rw-r--r--README.md36
2 files changed, 28 insertions, 33 deletions
diff --git a/Biz.md b/Biz.md
new file mode 100644
index 0000000..befd4ad
--- /dev/null
+++ b/Biz.md
@@ -0,0 +1,25 @@
+# Biz
+
+The end is financial independence. The means: write everything down,
+first in English, then in code. Automate it until we don't have to work
+any longer.
+
+Compounding returns are magical. Wealth is found in asymmetries.
+
+## Goals of the workflow
+
+- have minimal ceremony
+- default to asynchrony, but allow for synchronous work when necessary
+- automate the boring stuff
+- standardize environments, tooling, and versions to minimize friction
+ while collaborating
+- support the longevity and self-sustainability of the project
+
+Ideally, each contributor should be able to go off grid for a day or a
+week or more, continue working offline, submit their work when finished,
+and have no or minimal conflicts. This also refers to the resilience of
+the production systems.
+
+We should never need "out of office" email auto-replies, or urgent
+contact. No pager duty, no daily stand-ups. Yes, this policy will affect
+what code we write, not just how we write it; that is by design.
diff --git a/README.md b/README.md
index 6c6edf2..d41317a 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,8 @@
-# Biz
-
-The end is financial independence. The means: write everything down,
-first in English, then in code. Automate it until we don't have to work
-any longer.
-
-Compounding returns are magical. Wealth is found in asymmetries.
-
-## Goals of the workflow
-
-- have minimal ceremony
-- default to asynchrony, but allow for synchronous work when necessary
-- automate the boring stuff
-- standardize environments, tooling, and versions to minimize friction
- while collaborating
-- support the longevity and self-sustainability of the project
-
-Ideally, each contributor should be able to go off grid for a day or a
-week or more, continue working offline, submit their work when finished,
-and have no or minimal conflicts. This also refers to the resilience of
-the production systems.
+Jump into a development shell:
-We should never need "out of office" email auto-replies, or urgent
-contact. No pager duty, no daily stand-ups. Yes, this policy will affect
-what code we write, not just how we write it; that is by design.
+ nix-shell
-## Layout
+Then run `help` to see the dev commands.
The source tree maps to the module namespace, and roughly follows the
Haskell namespace hierarchy (although nothing is enforced). The main
@@ -59,11 +37,3 @@ handle the file. So for example:
this, but we use them to make plans and such
- `.jnl` is a journal for accounting, the build system will check our
balances, make sure we're profitable
-
-## Development
-
-Jump into a development shell:
-
- nix-shell
-
-Then run `help` to see the dev commands.