akkartik/mu
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
main
mu/tools
History
Kartik K. Agaram 8e9ddaee55 .
2021-11-11 12:52:51 -08:00
..
termbox 7233 - fix some warnings from gcc 9 2020-11-13 20:53:32 -08:00
browse_trace 5800 - move browse_trace to tools/ dir 2019-12-07 18:15:49 -08:00
browse_trace.cc 5910 2020-01-20 02:58:31 -08:00
browse_trace.readme.md 7846 2021-03-04 00:11:23 -08:00
create_container 5891 2020-01-14 01:52:54 -08:00
expand_string_handle - 2020-05-18 00:44:50 -07:00
image-data . 2021-10-10 08:35:59 -07:00
linkify.cc 5799 - move html-generation to tools/ directory 2019-12-07 18:06:17 -08:00
mu-init-minify.subx clean up treeshaking support for baremetal 2021-10-30 07:29:15 -07:00
README.md 5868 2020-01-02 12:27:35 -08:00
regs.mu html: better highlighting for int registers 2021-06-26 20:55:36 -07:00
test_treeshake_translate 5796 - move treeshake to a new tools/ directory 2019-12-07 18:05:06 -08:00
translate_minified clean up treeshaking support for baremetal 2021-10-30 07:29:15 -07:00
treeshake.cc 5796 - move treeshake to a new tools/ directory 2019-12-07 18:05:06 -08:00
update_html . 2021-11-11 12:52:51 -08:00
update_signatures . 2021-10-30 12:11:47 -07:00
vga_palette 7842 - new directory organization 2021-03-03 22:21:03 -08:00
vga_palette.c 7842 - new directory organization 2021-03-03 22:21:03 -08:00
vga_palette.png 7842 - new directory organization 2021-03-03 22:21:03 -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.