Add documentation for scripts/symlink_generated_files.sh
Test Plan: N/a
X-Origin-Diff: phab/D309
GitOrigin-RevId: 0e0d29f1e981ba383e38256f496f77f726a3c29a
diff --git a/README.md b/README.md
index eb40c08..a485922 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,20 @@
Running commands: `scripts/run_in_container.sh <...>`
Using bazel using a wrapper script: `scripts/bin/bazel <...>` (add to your local $PATH for convenience)
+
+#### Creating local symlinks for generated Go code
+
+Unfortunately, the Go tooling does not yet know about Bazel, so we need to copy generated code to
+the source tree such that native Go modules work.
+
+This creates a fake GOPATH and symlinks for generated packages:
+
+ scripts/symlink_generated_files.sh
+ bazel build :gopath
+
+Any top-level Go targets that use generated code have to be dependencies of the :gopath target.
+
+See https://phab.monogon.dev/D305 for details.
#### IntelliJ