tools/README.md

   1 Run all these from the top-level `mu/` directory.
   2
   3 ### Some tools for Mu's build process
   4
   5 These are built automatically.
   6
   7 * `enumerate`: list numeric files in current directory, optionally `--until`
   8   some prefix.
   9
  10
  11 ### Miscellaneous odds and ends
  12
  13 These are built lazily.
  14
  15 * `browse_trace`: debugging tool. See `browse_trace.readme.md` for details.
  16
  17 * `linkify`: inserts hyperlinks from variables to definitions in Mu's html
  18   sources. Hacky; just see the number of tests. Invoked by `update_html`.
  19
  20 * `treeshake_all`: rebuild SubX binaries without tests and unused functions.
  21   Hacky; just helps estimate the code needed to perform various tasks.
  22   ```
  23   tools/treeshake_all
  24   ```
  25
  26 ### Notes to self: constraints on the tools/ directory
  27 * Don't overwhelm the initial view of the project with lots of crap in the
  28   root directory.
  29 * Directories go up top in the github view, so too many sub-directories are
  30   also overwhelming.
  31 * Don't increase increase build time too much; everything in `tools/` shouldn't
  32   be automatically built.
  33   * stuff needed all the time is built from root directory.
  34 * `tools/` contains many independent things; don't make it hard to see
  35   boundaries. Ideally just one source file per tool. If not, give related
  36   files similar name prefixes.