From 29f3b3c7c17f6cf6ad807a2a09f67d889182bc09 Mon Sep 17 00:00:00 2001
From: Jacob MacDonald <jakemac@google.com>
Date: Mon, 21 Oct 2024 01:52:05 -0700
Subject: [PATCH] add readme with instructions to the _macro_tool (#107)

---
 pkgs/_macro_tool/README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 pkgs/_macro_tool/README.md

diff --git a/pkgs/_macro_tool/README.md b/pkgs/_macro_tool/README.md
new file mode 100644
index 00000000..d2580045
--- /dev/null
+++ b/pkgs/_macro_tool/README.md
@@ -0,0 +1,15 @@
+A tool for running macro examples end to end.
+
+## Example usage
+
+The following will run the json_codable example, assuming you start at the root
+of this repo:
+
+```bash
+dart pkgs/_macro_tool/bin/main.dart \
+  --workspace=goldens/foo \
+  --packageConfig=.dart_tool/package_config.json \
+  --script=goldens/foo/lib/json_codable_test.dart
+```
+
+You can also enable watch mode using `--watch`.