commit b0b5a94d15f1cedc92697074d367a56c18db6fa2
author Darren Krahn <dkrahn@google.com> Thu Aug 17 20:46:53 2023 +0000
committer CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> Thu Aug 17 20:46:53 2023 +0000
tree 33a79b47e9c3de42eeba116d85fb8670c356e0ea
parent 73454b39c45aabdffc1c362a2667f3c4ed22c115

Update build instructions in the readme

Also clean up comments in .gitmodules about transformations, those are
no longer active.

Test: Ran build instructions on clean clone from github
Change-Id: I6ccdd7c9dbc4bdc58707eacfb468b89d02d0d6e4
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/164350
Reviewed-by: Andrew Scull <ascull@google.com>
Commit-Queue: Darren Krahn <dkrahn@google.com>

.gitmodules

diff --git a/.gitmodules b/.gitmodules
index 50b3395..ceed45f 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -1,8 +1,3 @@
-# These paths may transform when this repo is mirrored. For example, the github
-# mirror of this repo should reference the github mirror of submodules.
-#
-# transformation version: 1
-#
 [submodule "boringssl"]
 	path = third_party/boringssl/src
 	url = https://pigweed.googlesource.com/third_party/boringssl/boringssl

.gn

diff --git a/.gn b/.gn
index 52124fd..e03b864 100644
--- a/.gn
+++ b/.gn
@@ -13,3 +13,4 @@
 # the License.
 
 buildconfig = "//BUILDCONFIG.gn"
+export_compile_commands = [ "//*" ]

README.md

diff --git a/README.md b/README.md
index 17fc4cc..27806c9 100644
--- a/README.md
+++ b/README.md
@@ -43,15 +43,30 @@
 
 Different implementations use different third party libraries. The third\_party
 directory contains build files and git submodules for each of these. The
-[bootstrap](bootstrap.sh) script will automatically initialize all submodules.
+submodules must be initialized once after cloning the repo, using `git submodule
+update --init`, and updated after pulling commits that roll the submodules using
+`git submodule update`.
 
 ### Building and Running Tests
 
+#### Quick setup
+
+To setup the build environment the first time:
+
 ```bash
+$ git submodule update --init
 $ source bootstrap.sh
+$ gn gen out
+```
+
+To build and run tests:
+
+```bash
 $ ninja -C out
 ```
 
+#### More details
+
 The easiest way, and currently the only supported way, to build and run tests is
 from a [Pigweed](https://pigweed.googlesource.com/pigweed/pigweed/) environment
 on Linux. Pigweed does support other host platforms so it shouldn't be too hard