diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 10 insertions, 2 deletions
@@ -23,5 +23,13 @@ also do `make lint` to get a linting / critique of all the source files (`lint` runs `fmt` first, so you need to have installed the packages above as well). -Note that the `Makefile` is *for development*, it's not used on -production machines. +Note that the `Makefile` is *for development*, it's not used after the +code is built. + +## Structure + +* the entry points go under `cmd/`, with a matching target in the + `Makefile` +* the `factory` constructs all the singletons that actually do things + (e.g. listeners, models, clients, business logic objects) +* the `config` handles all configuration for the entire application |