diff options
author | Ben Sima <ben@bsima.me> | 2020-12-08 13:15:55 -0500 |
---|---|---|
committer | Ben Sima <ben@bsima.me> | 2020-12-08 13:15:55 -0500 |
commit | ca06b25725a938f65e022f0749e641c3b4225879 (patch) | |
tree | 8ccf3f90124083721368129e8a61172d84afcc7c | |
parent | 6722bb77093d16523db926f5894e7d987eeadbf1 (diff) |
Update docs, remove useless README
-rw-r--r-- | Biz/Dev.md | 9 | ||||
-rw-r--r-- | README.md | 2 |
2 files changed, 6 insertions, 5 deletions
@@ -40,10 +40,13 @@ as possible. Only after sufficient iteration such that interfaces are solidified and functionality is well-established should some code be promoted up the namespace hierarchy. -Boundaries and interfaces between namespaces should be small and +Start with small namespaces: use `Biz/Thing.hs` before `Biz/Thing/Service.hs`. +Try to keep all related code in one spote for as long as possible. + +Boundaries and interfaces between namespaces should be singular and well-defined. Likewise, the functionality and purpose of a particular -namespace should be small and well-defined. Following the unix principle -of "do one thing and do it well" is advised. +namespace should be singular and well-defined. Follow the unix principle +of "do one thing and do it well." Namespaces are always capitalized. I would prefer always lowercase, but `ghc` _really_ wants capitalized files, so we appeas `ghc`. In Scheme diff --git a/README.md b/README.md deleted file mode 100644 index 6e343ce..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -[![builds.sr.ht status](https://builds.sr.ht/~ben/biz/commits/.build.yml.svg)](https://builds.sr.ht/~ben/biz/commits/.build.yml?) - |