From 2249e605c19f0dbe0c34c1c4f635b802f56dc535 Mon Sep 17 00:00:00 2001 From: Kartik Agaram Date: Sun, 8 Dec 2019 23:16:33 -0800 Subject: 5805 --- tools/Readme.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'tools') diff --git a/tools/Readme.md b/tools/Readme.md index fd889ec5..9e59dabe 100644 --- a/tools/Readme.md +++ b/tools/Readme.md @@ -22,3 +22,15 @@ These are built lazily. ``` tools/treeshake_all ``` + +### Notes to self: constraints on the tools/ directory +* Don't overwhelm the initial view of the project with lots of crap in the + root directory. +* Directories go up top in the github view, so too many sub-directories are + also overwhelming. +* Don't increase increase build time too much; everything in `tools/` shouldn't + be automatically built. + * stuff needed all the time is built from root directory. +* `tools/` contains many independent things; don't make it hard to see + boundaries. Ideally just one source file per tool. If not, give related + files similar name prefixes. -- cgit 1.4.1-2-gfad0