From 66dc1883b5ed0cea8b77852bfd7349e97fd2e6f3 Mon Sep 17 00:00:00 2001 From: Prithvi Prabhu Date: Wed, 14 Apr 2021 16:49:00 -0700 Subject: [PATCH] docs: Add README to wavegen #612 --- tools/wavegen/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 tools/wavegen/README.md diff --git a/tools/wavegen/README.md b/tools/wavegen/README.md new file mode 100644 index 0000000000..015c9f854f --- /dev/null +++ b/tools/wavegen/README.md @@ -0,0 +1,12 @@ +# Wavegen + +Wavegen code-generates language-specific counterparts of front-end cards/components for use in language-specfic drivers. Uses the Typescript compiler API. + +To use the generator, run `make generate` using the root `Makefile`. + +If you make changes to the generator, you'll need to compile it to update the drivers. + +Steps: +1. Run `make setup` to set up development dependencies (one-time). +2. Run `make build` to build the generator (every time you make changes to the generator). +3. Run `make run` to run the generator (every time you make changes to the UI). Same as calling `make generate` from the root `Makefile`. \ No newline at end of file