akkartik
/
mu
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
mu/tools
History
Kartik Agaram 535755316b 5837 - better colors for trace browser 2019-12-28 14:06:25 -08:00
..
termbox 5800 - move `browse_trace` to `tools/` dir 2019-12-07 18:15:49 -08:00
Readme.md 5805 2019-12-08 23:31:05 -08:00
browse_trace 5800 - move `browse_trace` to `tools/` dir 2019-12-07 18:15:49 -08:00
browse_trace.cc 5837 - better colors for trace browser 2019-12-28 14:06:25 -08:00
browse_trace.readme.md 5800 - move `browse_trace` to `tools/` dir 2019-12-07 18:15:49 -08:00
enumerate.cc 5797 - move `enumerate/` to `tools/` directory 2019-12-07 18:06:16 -08:00
linkify.cc 5799 - move html-generation to `tools/` directory 2019-12-07 18:06:17 -08:00
tangle.cc 5801 - move `tangle` to `tools/` dir 2019-12-07 18:15:49 -08:00
tangle.readme.md 5801 - move `tangle` to `tools/` dir 2019-12-07 18:15:49 -08:00
test_treeshake_translate 5796 - move treeshake to a new tools/ directory 2019-12-07 18:05:06 -08:00
treeshake.cc 5796 - move treeshake to a new tools/ directory 2019-12-07 18:05:06 -08:00
treeshake_all 5796 - move treeshake to a new tools/ directory 2019-12-07 18:05:06 -08:00
treeshake_translate 5796 - move treeshake to a new tools/ directory 2019-12-07 18:05:06 -08:00
update_html 5799 - move html-generation to `tools/` directory 2019-12-07 18:06:17 -08:00

Readme.md

Run all these from the top-level mu/ directory.

Some tools for Mu's build process

These are built automatically.

  • enumerate: list numeric files in current directory, optionally --until some prefix.

Miscellaneous odds and ends

These are built lazily.

  • browse_trace: debugging tool. See browse_trace.readme.md for details.

  • linkify: inserts hyperlinks from variables to definitions in Mu's html sources. Hacky; just see the number of tests. Invoked by update_html.

  • treeshake_all: rebuild SubX binaries without tests and unused functions. Hacky; just helps estimate the code needed to perform various tasks.

    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.